Package org.apache.juneau.marshall.json5l

Class Json5lParserSession

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

org.apache.juneau.marshall.json5l.Json5lParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordReadable, RecordReadable, TokenReadable

public class Json5lParserSession
extends Json5ParserSession

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

Extends Json5ParserSession to inherit the full JSON5 dialect (single-quoted strings, bare/unquoted field names, trailing commas, missing values, comments, relaxed numbers) and re-adds JSONL's newline-delimited framing: input is read one line at a time, blank and comment-only lines are skipped, and each remaining line is parsed as one JSON5 value.

Notes:

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

See Also:

• JSON5L Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Json5lParserSession.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	Json5lParserSession(Json5lParserSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static Json5lParserSession.Builder	create(Json5lParser ctx)	Creates a new builder for this object.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
RecordReader	readArrayRecords(Object input)	Streaming array-element RecordReader for JSON5L.
TokenReader	readTokens(Object input)	Opens a low-level pull-parser cursor over a JSON5L document, bound to this live session.

Methods inherited from class org.apache.juneau.marshall.json5.Json5ParserSession

allowsTrailingComma, canCoerceNonStringToString, create, isCommentOrWhitespace, isNumberStartChar, isWhitespace, newGenericList, newGenericMap, onEmptyInput, onMissingValue, readFieldName, readNumber, readNumber, readString, skipCommentsAndSpace

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

create, doReadIntoCollection, doReadIntoMap, getJsonClassMeta, isValidateEnd, 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

Json5lParserSession

protected Json5lParserSession(Json5lParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static Json5lParserSession.Builder create(Json5lParser 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 JSON5L document, bound to this live session.

Each top-level JSON5 value (one per line) is emitted as a flat sequence at depth 0; there is no virtual root container. Same honored/ignored builder properties as Json5ParserSession.readTokens(Object).

Specified by:

readTokens in interface TokenReadable

Overrides:

readTokens in class Json5ParserSession

Parameters:

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

Returns:

A new Json5lTokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Streaming array-element RecordReader for JSON5L.

Aliases the JSON5L line record stream: the Json5lTokenReader returned by readTokens(Object) is itself a RecordReader that yields one record per top-level line at depth 0. Memory is O(1) in the number of lines.

Specified by:

readArrayRecords in interface ArrayRecordReadable

Overrides:

readArrayRecords in class JsonParserSession

Parameters:

input - The input.

Returns:

A new line-delimited RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

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 JsonParserSession

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.