Package org.apache.juneau.marshall.parser

Class InputStreamParserSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.parser.ParserSession

org.apache.juneau.marshall.parser.InputStreamParserSession

All Implemented Interfaces:

BeanSession, ConverterSession

Direct Known Subclasses:

BsonParserSession, CborParserSession, MsgPackParserSession, ParquetParserSession, RdfStreamParserSession

public class InputStreamParserSession
extends ParserSession

Subclass of parser session objects for byte-based parsers.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• Serializers and Parsers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputStreamParserSession.Builder<SELF extends InputStreamParserSession.Builder<SELF>>	Builder class.
static final class	InputStreamParserSession.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() path (CRTP terminal).

Field Summary

Fields inherited from class org.apache.juneau.marshall.parser.ParserSession

DEFAULT_MAX_PARSE_DEPTH

Fields inherited from class org.apache.juneau.marshall.MarshallingSession

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputStreamParserSession(InputStreamParserSession.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static InputStreamParserSession.Builder<?>	create(InputStreamParser ctx)	Creates a new builder for this object.
final ParserPipe	createPipe(Object input)	Wraps the specified input object into a ParserPipe object so that it can be easily converted into a stream or reader.
protected final BinaryFormat	getBinaryFormat()	Binary input format.
boolean	hasNativeBytes()	Returns whether this binary parser has a native byte-array wire type.
final boolean	isReaderParser()	Returns true if this parser subclasses from ReaderParser.

Methods inherited from class org.apache.juneau.marshall.parser.ParserSession

allocateLocal, cast, checkRequired, convertAttrToType, create, doRead, doReadIntoCollection, doReadIntoMap, doReadToBeanConsumer, enterParseDepth, exitParseDepth, getCalendarFormat, getClassMeta, getDateFormat, getDebugOutputLines, getDurationFormat, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getLocaleFormat, getNulls, getOuter, getPeriodFormat, getPosition, getSchema, getStringBuilder, getTemporalFormat, getTimeZoneFormat, isAutoCloseStreams, isTrimStrings, isUnbuffered, mark, onBeanSetterException, onUnknownProperty, parentBean, properties, read, read, read, read, read, read, readArgs, readCalendar, readDate, readDuration, readIntoCollection, readIntoMap, readPeriod, readTemporal, readToBeanConsumer, returnStringBuilder, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, swapParentBean, trim, trim, unmark, unswap

Methods inherited from class org.apache.juneau.marshall.MarshallingSession

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.marshall.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

InputStreamParserSession

protected InputStreamParserSession(InputStreamParserSession.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.
Cannot be null.

Method Details

create

public static InputStreamParserSession.Builder<?> create(InputStreamParser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

createPipe

public final ParserPipe createPipe(Object input)

Wraps the specified input object into a ParserPipe object so that it can be easily converted into a stream or reader.

Overrides:

createPipe in class ParserSession

Parameters:

input - The input.
This can be any of the following types:

• null
• InputStream
• byte[]
• CharSequence containing encoded bytes according to the MarshallingContext.Builder#binaryFormat(BinaryFormat) setting.

Returns:

A new ParserPipe wrapper around the specified input object.

isReaderParser

public final boolean isReaderParser()

Description copied from class: ParserSession

Returns true if this parser subclasses from ReaderParser.

Overrides:

isReaderParser in class ParserSession

Returns:

true if this parser subclasses from ReaderParser.

getBinaryFormat

protected final BinaryFormat getBinaryFormat()

Binary input format.

Returns:

The format to use when converting strings to byte arrays.

See Also:

• MarshallingContext.Builder.binaryFormat(BinaryFormat)

hasNativeBytes

public boolean hasNativeBytes()

Returns whether this binary parser has a native byte-array wire type.

Mirror of OutputStreamSerializerSession.hasNativeBytes() for the parse side. When true, byte[] payloads are consumed natively from the binary stream (e.g. MsgPack bin family, CBOR byte-string major type 2, BSON binary subtype 0x05) and BinarySwap skips so the raw bytes reach the bean property directly. When false the parser surfaces byte[] payloads as a string (UTF-8 column for Parquet, plain literal for binary RDF) and BinarySwap fires to apply the configured BinaryFormat reverse decoding back to byte[].

Defaults to true. Subclasses without a native byte-array wire type (e.g. ParquetParserSession and the binary RDF parser sessions) override and return false.

Returns:

true if this parser has a native byte-array wire type.