Package org.apache.juneau.marshall.json5

Class Json5ParserSession

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

org.apache.juneau.marshall.json5.Json5ParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordReadable, RecordReadable, TokenReadable

Direct Known Subclasses:

Json5lParserSession

public class Json5ParserSession
extends JsonParserSession

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

Extends JsonParserSession to support JSON5 syntax including unquoted attribute names, single-quoted strings, string concatenation, JavaScript comments, and relaxed number formats.

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	Json5ParserSession.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.json.JsonParserSession

JsonParserSession.DefaultBuilder

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	Json5ParserSession(Json5ParserSession.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 Json5ParserSession.Builder	create(Json5Parser ctx)	Creates a new builder for this object.
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	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().
protected String	readFieldName(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 JSON5 document, bound to this live session.
protected void	skipCommentsAndSpace(ParserReader r)

Methods inherited from class org.apache.juneau.marshall.json.JsonParserSession

create, doRead, doReadIntoCollection, doReadIntoMap, getJsonClassMeta, isValidateEnd, readArrayRecords, readKeyword, skipComments

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

Json5ParserSession

protected Json5ParserSession(Json5ParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static Json5ParserSession.Builder create(Json5Parser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

readTokens

public TokenReader readTokens(Object input)
                       throws IOException

Opens a low-level pull-parser cursor over a JSON5 document, bound to this live session.

Same honored/ignored builder properties as JsonParserSession.readTokens(Object); the JSON5 dialect relaxations (single-quoted strings, bare identifiers, trailing commas, missing values) are applied unconditionally as part of the format.

Specified by:

readTokens in interface TokenReadable

Overrides:

readTokens in class JsonParserSession

Parameters:

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

Returns:

A new Json5TokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

readFieldName

protected String readFieldName(ParserReader r)
                        throws IOException,
ParseException

Overrides:

readFieldName in class JsonParserSession

Throws:

IOException

ParseException

readString

protected String readString(ParserReader r)
                     throws IOException,
ParseException

Overrides:

readString in class JsonParserSession

Throws:

IOException

ParseException

isNumberStartChar

protected boolean isNumberStartChar(int c)

Description copied from class: JsonParserSession

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).

Overrides:

isNumberStartChar in class JsonParserSession

Parameters:

c - The next non-whitespace character.

Returns:

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

readNumber

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

Overrides:

readNumber in class JsonParserSession

Throws:

IOException

ParseException

readNumber

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

Overrides:

readNumber in class JsonParserSession

Throws:

ParseException

skipCommentsAndSpace

protected void skipCommentsAndSpace(ParserReader r)
                             throws IOException,
ParseException

Overrides:

skipCommentsAndSpace in class JsonParserSession

Throws:

IOException

ParseException

isCommentOrWhitespace

protected boolean isCommentOrWhitespace(int cp)

Description copied from class: JsonParserSession

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

Overrides:

isCommentOrWhitespace in class JsonParserSession

Parameters:

cp - The codepoint.

Returns:

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

isWhitespace

protected boolean isWhitespace(int cp)

Description copied from class: JsonParserSession

Returns true if the specified character is whitespace.

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

Overrides:

isWhitespace in class JsonParserSession

Parameters:

cp - The codepoint.

Returns:

true if the specified character is whitespace.

onEmptyInput

protected void onEmptyInput()

Description copied from class: JsonParserSession

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

Overrides:

onEmptyInput in class JsonParserSession

onMissingValue

protected void onMissingValue()

Description copied from class: JsonParserSession

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

Overrides:

onMissingValue in class JsonParserSession

allowsTrailingComma

protected boolean allowsTrailingComma()

Description copied from class: JsonParserSession

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.

Overrides:

allowsTrailingComma in class JsonParserSession

Returns:

true if a trailing comma should be silently accepted.

canCoerceNonStringToString

protected boolean canCoerceNonStringToString()

Description copied from class: JsonParserSession

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

Overrides:

canCoerceNonStringToString in class JsonParserSession

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 JsonParserSession

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 JsonParserSession

Returns:

A new list.