Package org.apache.juneau.marshall.json5

Class Json5TokenReader

java.lang.Object

org.apache.juneau.marshall.json.JsonTokenReader

org.apache.juneau.marshall.json5.Json5TokenReader

All Implemented Interfaces:

Closeable, AutoCloseable, RecordReader, TokenReader

Direct Known Subclasses:

Json5lTokenReader

public class Json5TokenReader
extends JsonTokenReader

Reference implementation of the public TokenReader surface for the JSON5 format.

Subclasses JsonTokenReader to add the JSON5 dialect's relaxations:

• Strings can be single-quoted, double-quoted, or unquoted bare identifiers.
• Field names can be single-quoted, double-quoted, or unquoted bare identifiers.
• Trailing commas before ] / } are allowed.
• Missing values in arrays / objects emit TokenType.VALUE_NULL.
• JavaScript comments (// line, /* */ block) are tolerated — already accepted by the parent class.
• JSON5 numbers: leading +, leading/trailing decimal points, hexadecimal, Infinity/NaN.
• String line-continuation (backslash + line terminator is omitted from the value).

The cursor is a true O(1)-memory streaming cursor (TokenReader.isStreaming() == true).

Notes:

• This class is not thread safe.
• The cursor is purely structural; object swaps and @Schema annotations have no effect. Use the POJO databind path on Json5Parser for those.

Nested Class Summary

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

JsonTokenReader.Settings

Field Summary

Fields inherited from class org.apache.juneau.marshall.json.JsonTokenReader

currentBoolean, currentFieldName, currentNumberLexeme, currentString, currentToken, depth, r, S00_expectValue, S01_expectFieldName, S02_expectColon, S03_expectCommaOrEndObject, S04_expectCommaOrEndArray, S05_end, settings, state

Fields inherited from interface org.apache.juneau.marshall.stream.TokenReader

MSG_READ_NON_VALUE_STATE

Constructor Summary

Constructors

Constructor	Description
Json5TokenReader(ParserPipe pipe)	Constructor with default settings.
Json5TokenReader(ParserPipe pipe, JsonTokenReader.Settings settings, Json5ParserSession session)	Constructor used by Json5ParserSession.readTokens(Object) to plumb the calling session through so that JsonTokenReader.read(Class) can delegate to the JSON5 databind path.

Method Summary

Modifier and Type	Method	Description
protected boolean	allowsTrailingComma()	Subclass extension point: returns whether trailing commas are accepted before ] / }.
Number	getNumber()	Returns the current numeric value as a parsed Number.
protected void	readCommaOrEndArray(int c)	State-machine dispatch: handles the next character at JsonTokenReader.S04_expectCommaOrEndArray.
protected void	readCommaOrEndObject(int c)	State-machine dispatch: handles the next character at JsonTokenReader.S03_expectCommaOrEndObject.
protected void	readFieldNameOrEndObject(int c)	State-machine dispatch: handles the next character at JsonTokenReader.S01_expectFieldName.
protected void	readNumberValue()	Reads a JSON number from the current input position.
protected String	readString()	Reads a double-quoted JSON string from the current input position.
protected void	readValueStart(int c)	State-machine dispatch: handles the next character at JsonTokenReader.S00_expectValue.

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

afterValue, canRead, close, getBinary, getBool, getCurrentToken, getDepth, getFieldName, getNumberLexeme, getString, isDigit, isInArray, isNumberStart, next, parseException, popContainer, pushContainer, read, read, read, readKeywordValue, readSkipWsAndComments, skipChildren

Methods inherited from class java.lang.Object

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

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

iterator, stream

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

getExtType, getNativeKind, getSimpleValue, getTag, getTagCount, isStreaming

Constructor Details

Json5TokenReader

public Json5TokenReader(ParserPipe pipe)
                 throws IOException

Constructor with default settings.

Parameters:

pipe - The parser input pipe to read from. Must not be null.

Throws:

IOException - If a problem occurred opening the underlying reader.

Json5TokenReader

public Json5TokenReader(ParserPipe pipe,
 JsonTokenReader.Settings settings,
 Json5ParserSession session)
                 throws IOException

Constructor used by Json5ParserSession.readTokens(Object) to plumb the calling session through so that JsonTokenReader.read(Class) can delegate to the JSON5 databind path.

Parameters:

pipe - The parser input pipe to read from. Must not be null.

settings - The cursor-level settings. Must not be null.

session - The Json5ParserSession for JsonTokenReader.read(Class) delegation, or null to disable read.

Throws:

IOException - If a problem occurred opening the underlying reader.

Method Details

allowsTrailingComma

protected boolean allowsTrailingComma()

Description copied from class: JsonTokenReader

Subclass extension point: returns whether trailing commas are accepted before ] / }.

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

Overrides:

allowsTrailingComma in class JsonTokenReader

Returns:

true if a trailing comma should be silently accepted; false if it should produce a parse error.

readNumberValue

protected void readNumberValue()
                        throws IOException,
ParseException

Description copied from class: JsonTokenReader

Reads a JSON number from the current input position. Captures the lexeme via ParserReader.readNumberString() and validates it; defers actual numeric parsing to JsonTokenReader.getNumber() (lazy). Sets JsonTokenReader.currentNumberLexeme and JsonTokenReader.currentToken.

Overrides:

readNumberValue in class JsonTokenReader

Throws:

IOException - If a problem occurred reading from the underlying stream.

ParseException - If the input is not a valid JSON number.

getNumber

public Number getNumber()
                 throws ParseException

Description copied from interface: TokenReader

Returns the current numeric value as a parsed Number.

Implementations may parse lazily; the returned Number subtype is implementation- and format-defined (e.g. Long / Double / BigDecimal). Use TokenReader.getNumberLexeme() to recover the original textual form.

Specified by:

getNumber in interface TokenReader

Overrides:

getNumber in class JsonTokenReader

Returns:

The parsed numeric value.

Throws:

ParseException - If the lexeme cannot be parsed.

readValueStart

protected void readValueStart(int c)
                       throws IOException,
ParseException

Description copied from class: JsonTokenReader

State-machine dispatch: handles the next character at JsonTokenReader.S00_expectValue.

Subclasses (e.g. Json5TokenReader) override this to add dialect-specific value shapes (single-quoted strings, bare identifiers, missing-value handling).

Overrides:

readValueStart in class JsonTokenReader

Parameters:

c - The next non-whitespace, non-comment character read from the input.

Throws:

IOException - If a problem occurred reading from the underlying stream.

ParseException - If the input is malformed at this position.

readFieldNameOrEndObject

protected void readFieldNameOrEndObject(int c)
                                 throws IOException,
ParseException

Description copied from class: JsonTokenReader

State-machine dispatch: handles the next character at JsonTokenReader.S01_expectFieldName.

Subclasses (e.g. Json5TokenReader) override this to accept bare-identifier field names and single-quoted field names.

Overrides:

readFieldNameOrEndObject in class JsonTokenReader

Parameters:

c - The next non-whitespace character read from the input.

Throws:

IOException - If a problem occurred reading from the underlying stream.

ParseException - If the input is malformed at this position.

readCommaOrEndArray

protected void readCommaOrEndArray(int c)
                            throws IOException,
ParseException

Description copied from class: JsonTokenReader

State-machine dispatch: handles the next character at JsonTokenReader.S04_expectCommaOrEndArray.

Subclasses (e.g. Json5TokenReader) override this to accept trailing commas before ].

Overrides:

readCommaOrEndArray in class JsonTokenReader

Parameters:

c - The next non-whitespace character read from the input.

Throws:

IOException - If a problem occurred reading from the underlying stream.

ParseException - If the input is malformed at this position.

readCommaOrEndObject

protected void readCommaOrEndObject(int c)
                             throws IOException,
ParseException

Description copied from class: JsonTokenReader

State-machine dispatch: handles the next character at JsonTokenReader.S03_expectCommaOrEndObject.

Subclasses (e.g. Json5TokenReader) override this to accept trailing commas before }.

Overrides:

readCommaOrEndObject in class JsonTokenReader

Parameters:

c - The next non-whitespace character read from the input.

Throws:

IOException - If a problem occurred reading from the underlying stream.

ParseException - If the input is malformed at this position.

readString

protected String readString()
                     throws IOException,
ParseException

Description copied from class: JsonTokenReader

Reads a double-quoted JSON string from the current input position.

Handles escape sequences (\\n, \\t, \\uNNNN, etc.) inline via ParserReader.replace(char). Subclasses (e.g. Json5TokenReader) override this to also accept single-quoted strings.

Overrides:

readString in class JsonTokenReader

Returns:

The parsed string (without surrounding quotes).

Throws:

IOException - If a problem occurred reading from the underlying stream.

ParseException - If the input is malformed at this position.