Package org.apache.juneau.marshall.json5l

Class Json5lParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

org.apache.juneau.marshall.json.JsonParser

org.apache.juneau.marshall.json5.Json5Parser

org.apache.juneau.marshall.json5l.Json5lParser

All Implemented Interfaces:

JsonMetaProvider, ArrayRecordReadable, RecordReadable, TokenReadable

public class Json5lParser
extends Json5Parser

Parses JSON5L (JSON5 Lines) input into POJO models.

Media types

Handles Content-Type types: application/json5l, application/json5lines, text/json5l

Description

JSON5L combines the relaxed JSON5 dialect with JSONL's newline-delimited framing. Each non-empty, non-comment line is parsed as a complete JSON5 value (single-quoted strings, unquoted field names, trailing commas, comments, relaxed numbers). Because JSON5 is a strict superset of JSON, this parser also reads plain JSONL input unchanged.

Comment handling follows JSON5 line-by-line: a line that is blank or contains only a comment is skipped (like a blank line); inline comments within a record's JSON are tolerated. A /* */ block comment must open and close on the same physical line — block comments cannot span record boundaries.

Example:

// Parse JSON5L into a list of POJOs List<MyBean> list = Json5lParser.DEFAULT.read(json5lInput, List.class, MyBean.class);

Example input:

// header comment line {name:'Alice',age:30} {name:'Bob',age:25} // trailing comment

Notes:

• This class is thread safe and reusable.

See Also:

• JSON5L Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Json5lParser.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.ReaderParser

ReaderParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final Json5lParser	DEFAULT	Default parser, Accept=application/json5l.

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

validateEnd

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

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

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

marshallingContext

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

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
Json5lParser(Json5lParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
Json5lParser.Builder	copy()	Creates a builder from this context object.
static Json5lParser.Builder	create()	Creates a new builder for this object.
Json5lParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
Json5lParserSession	getSession()	Returns a session to use for this context.

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

getJsonBeanPropertyMeta, getJsonClassMeta, isValidateEnd, readArrayRecords, readTokens

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

getStreamCharset, isReaderParser, properties

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

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

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

getDurationFormat, getMarshallingContext, getPeriodFormat

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

createBuilder, getAnnotationProvider, init, 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.marshall.stream.RecordReadable

isRecordStreaming

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

readRecords

Field Details

DEFAULT

public static final Json5lParser DEFAULT

Default parser, Accept=application/json5l.

Constructor Details

Json5lParser

public Json5lParser(Json5lParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static Json5lParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public Json5lParser.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Json5Parser

Returns:

A new Builder object.

createSession

public Json5lParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class Json5Parser

Returns:

A new session builder.

getSession

public Json5lParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class Json5Parser

Returns:

A new session object.