Package org.apache.juneau.marshall.json

Class JsonParserSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.parser.ParserSession

org.apache.juneau.marshall.parser.ReaderParserSession

org.apache.juneau.marshall.json.JsonParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordReadable, RecordReadable, TokenReadable

Direct Known Subclasses:

Json5ParserSession, JsonlParserSession

public class JsonParserSession
extends ReaderParserSession
implements TokenReadable, ArrayRecordReadable

Session object that lives for the duration of a single use of JsonParser.

Notes:

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

See Also:

• JSON

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonParserSession.Builder<SELF extends JsonParserSession.Builder<SELF>>	Builder class.
static final class	JsonParserSession.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	JsonParserSession(JsonParserSession.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	allowsTrailingComma()	Returns whether trailing commas are accepted before ] / } in the databind path.
protected boolean	canCoerceNonStringToString()	Returns whether non-string types can be coerced to strings using newInstanceFromString().
static JsonParserSession.Builder<?>	create(JsonParser ctx)	Creates a new builder for this object.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
protected <E> Collection<E>	doReadIntoCollection(ParserPipe pipe, Collection<E> c, Type elementType)	Implementation method.
protected <K, V> Map<K,V>	doReadIntoMap(ParserPipe pipe, Map<K,V> m, Type keyType, Type valueType)	Implementation method.
protected JsonClassMeta	getJsonClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected boolean	isCommentOrWhitespace(int cp)	Returns true if the specified character is whitespace or '/'.
protected boolean	isNumberStartChar(int c)	Returns true if the specified character can start a number value.
protected boolean	isValidateEnd()	Validate end.
protected boolean	isWhitespace(int cp)	Returns true if the specified character is whitespace.
protected MarshalledList	newGenericList()	Creates a generic list for parser-driven list population.
protected MarshalledMap	newGenericMap()	Creates a string-keyed generic map for parser-driven map population.
protected void	onEmptyInput()	Hook called when empty input is detected in readAnything().
protected void	onMissingValue()	Hook called when a missing value is detected in readAnything().
RecordReader	readArrayRecords(Object input)	Streaming array-element RecordReader backed by JsonTokenReader.
protected String	readFieldName(ParserReader r)
protected void	readKeyword(String keyword, ParserReader r)
protected Number	readNumber(ParserReader r, Class<? extends Number> type)
protected Number	readNumber(ParserReader r, String s, Class<? extends Number> type)
protected String	readString(ParserReader r)
TokenReader	readTokens(Object input)	Opens a low-level pull-parser cursor over a JSON document, bound to this session's live BeanSession/MarshallingContext.
protected void	skipComments(ParserReader r)
protected void	skipCommentsAndSpace(ParserReader r)

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

create, createPipe, getStreamCharset, isReaderParser, properties

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

allocateLocal, cast, checkRequired, convertAttrToType, create, 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, 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, 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.marshall.stream.ArrayRecordReadable

isArrayRecordStreaming, readArrayRecords

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

get

Methods inherited from interface org.apache.juneau.marshall.stream.RecordReadable

isRecordStreaming

Methods inherited from interface org.apache.juneau.marshall.stream.TokenReadable

readRecords

Constructor Details

JsonParserSession

protected JsonParserSession(JsonParserSession.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JsonParserSession.Builder<?> create(JsonParser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

readFieldName

protected String readFieldName(ParserReader r)
                        throws IOException,
ParseException

Throws:

IOException

ParseException

readKeyword

protected void readKeyword(String keyword,
 ParserReader r)
                    throws IOException,
ParseException

Throws:

IOException

ParseException

readNumber

protected Number readNumber(ParserReader r,
 Class<? extends Number> type)
                     throws IOException,
ParseException

Throws:

IOException

ParseException

readNumber

protected Number readNumber(ParserReader r,
 String s,
 Class<? extends Number> type)
                     throws ParseException

Throws:

ParseException

readString

protected String readString(ParserReader r)
                     throws IOException,
ParseException

Throws:

IOException

ParseException

skipComments

protected void skipComments(ParserReader r)
                     throws ParseException,
IOException

Throws:

ParseException

IOException

skipCommentsAndSpace

protected void skipCommentsAndSpace(ParserReader r)
                             throws IOException,
ParseException

Throws:

IOException

ParseException

doRead

protected <T> T doRead(ParserPipe pipe,
 ClassMeta<T> type)
                throws IOException,
ParseException,
ExecutableException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method or Parser.doRead(ParserSession,ParserPipe,ClassMeta).

The default implementation of this method simply calls Parser.doRead(ParserSession,ParserPipe,ClassMeta).

Overrides:

doRead in class ParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, JsonMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

readTokens

public TokenReader readTokens(Object input)
                       throws IOException

Opens a low-level pull-parser cursor over a JSON document, bound to this session's live BeanSession/MarshallingContext.

The cursor is purely structural — object swaps and @Schema annotations are not applied at this layer. See TokenReader for the contract.

Builder properties honored:

The structurally-applicable subset flows through to the cursor: autoCloseStreams, unbuffered, trimStrings (applied to TokenType.VALUE_STRING and TokenType.FIELD_NAME values), and the ReaderParser stream/file charsets.

Builder properties NOT honored:

validateEnd() (the cursor leaves end-of-input checking to the caller), listener(...)/debugOutputLines(...), consumes(...), object swaps, and @Schema annotations (only applied on the POJO databind path).

Specified by:

readTokens in interface TokenReadable

Parameters:

input - The input. Accepts Reader, CharSequence, InputStream, or byte[].

Returns:

A new JsonTokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Streaming array-element RecordReader backed by JsonTokenReader. Memory is O(1) in the array length — elements are bound on demand using this live session.

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A new element-streamed RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

doReadIntoCollection

protected <E> Collection<E> doReadIntoCollection(ParserPipe pipe,
 Collection<E> c,
 Type elementType)
                                          throws IOException,
ParseException,
ExecutableException

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doReadIntoCollection in class ParserSession

Type Parameters:

E - The element type.

Parameters:

pipe - The parser input.

c - The collection being loaded.

elementType - The class type of the elements, or null to default to whatever is being parsed.

Returns:

The same collection that was passed in to allow this method to be chained.

Throws:

IOException

ParseException

ExecutableException

doReadIntoMap

protected <K,
V> Map<K,V> doReadIntoMap(ParserPipe pipe,
 Map<K,V> m,
 Type keyType,
 Type valueType)
                                throws IOException,
ParseException,
ExecutableException

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doReadIntoMap in class ParserSession

Type Parameters:

K - The key type.

V - The value type.

Parameters:

pipe - The parser input.

m - The map being loaded.

keyType - The class type of the keys, or null to default to String.class.

valueType - The class type of the values, or null to default to whatever is being parsed.

Returns:

The same map that was passed in to allow this method to be chained.

Throws:

IOException

ParseException

ExecutableException

getJsonClassMeta

protected JsonClassMeta getJsonClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

isNumberStartChar

protected boolean isNumberStartChar(int c)

Returns true if the specified character can start a number value.

JSON numbers start with a digit, -, or .. JSON5 subclasses also accept +, I (Infinity), and N (NaN).

Parameters:

c - The next non-whitespace character.

Returns:

true if a number lexeme should be read from this character.

isCommentOrWhitespace

protected boolean isCommentOrWhitespace(int cp)

Returns true if the specified character is whitespace or '/'.

Parameters:

cp - The codepoint.

Returns:

true if the specified character is whitespace or '/'.

isValidateEnd

protected boolean isValidateEnd()

Validate end.

Returns:

true if after parsing a POJO from the input, verifies that the remaining input in the stream consists of only comments or whitespace.

See Also:

• JsonParser.Builder.validateEnd()

isWhitespace

protected boolean isWhitespace(int cp)

Returns true if the specified character is whitespace.

Only 0x20 (space), 0x09 (tab), 0x0A (line feed) and 0x0D (carriage return) are considered whitespace.

Parameters:

cp - The codepoint.

Returns:

true if the specified character is whitespace.

onEmptyInput

protected void onEmptyInput()
                     throws ParseException

Hook called when empty input is detected in readAnything().

Throws:

ParseException - Always in strict mode.

onMissingValue

protected void onMissingValue()
                       throws ParseException

Hook called when a missing value is detected in readAnything().

Throws:

ParseException - Always in strict mode.

allowsTrailingComma

protected boolean allowsTrailingComma()

Returns whether trailing commas are accepted before ] / } in the databind path.

Default returns false (strict RFC-8259 JSON). Json5ParserSession overrides this to true for the JSON5 dialect.

Returns:

true if a trailing comma should be silently accepted.

canCoerceNonStringToString

protected boolean canCoerceNonStringToString()

Returns whether non-string types can be coerced to strings using newInstanceFromString().

Returns:

Always false for standard JSON.

newGenericMap

protected MarshalledMap newGenericMap()

Description copied from class: MarshallingSession

Creates a string-keyed generic map for parser-driven map population.

This is the main factory hook overridden by per-marshaller parser sessions to return their flavored XMap variant (for example, JsonParserSession returns JsonMap; Json5ParserSession returns Json5Map).

Overrides:

newGenericMap in class MarshallingSession

Returns:

A new map.

newGenericList

protected MarshalledList newGenericList()

Description copied from class: MarshallingSession

Creates a generic list for parser-driven list population.

Per-marshaller parser sessions override this hook to return their flavored XList variant (for example, JsonParserSession returns JsonList; Json5ParserSession returns Json5List).

Overrides:

newGenericList in class MarshallingSession

Returns:

A new list.