Package org.apache.juneau.marshall.json5l

Class Json5lSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.WriterSerializer

org.apache.juneau.marshall.json.JsonSerializer

org.apache.juneau.marshall.jsonl.JsonlSerializer

org.apache.juneau.marshall.json5l.Json5lSerializer

All Implemented Interfaces:

Function<Object,String>, ThrowingFunction<Object,String>, JsonMetaProvider, ArrayRecordWritable, RecordWritable, TokenWritable

public class Json5lSerializer
extends JsonlSerializer

Serializes POJO models to JSON5L (JSON5 Lines).

Media types

Handles Accept types: application/json5l, application/json5lines, text/json5l

Produces Content-Type types: application/json5l

Description

JSON5L combines the relaxed JSON5 dialect with JSONL's newline-delimited framing: each top-level value is written as a compact document on its own line, exactly as JsonlSerializer does.

By default the per-line output is strict RFC-8259 JSON (byte-identical to JsonlSerializer), keeping output maximally portable. The json5Sugar() opt-in switches the per-line output to JSON5 sugar (single-quoted strings, unquoted field names where safe).

Example:

// Strict-per-line output (default) String json5l = Json5lSerializer.DEFAULT.write(myList); // JSON5-sugar-per-line output Json5lSerializer serializer = Json5lSerializer.create().json5Sugar().build(); String json5l = serializer.write(myList);

Example output, sugar off (List of beans):

{"name":"Alice","age":30} {"name":"Bob","age":25}

Example output, sugar on:

{name:'Alice',age:30} {name:'Bob',age:25}

Notes:

• This class is thread safe and reusable.

See Also:

• JSON5L Basics

Nested Class Summary

Nested Classes

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

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

JsonSerializer.DefaultBuilder, JsonSerializer.Readable

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final Json5lSerializer	DEFAULT	Default serializer, strict-JSON-per-line.

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

addBeanTypesJson, DEFAULT_READABLE, escapeSolidus

Fields inherited from class org.apache.juneau.marshall.serializer.WriterSerializer

maxIndent, quoteChar, quoteCharOverride, useWhitespace

Fields inherited from class org.apache.juneau.marshall.serializer.Serializer

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

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
Json5lSerializer(Json5lSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
Json5lSerializer.Builder	copy()	Creates a builder from this context object.
static Json5lSerializer.Builder	create()	Creates a new builder for this object.
Json5lSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
Json5lSerializerSession	getSession()	Returns a session to use for this context.
boolean	isJson5Sugar()	Returns true if this serializer emits JSON5 sugar on each line.

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

getJsonBeanPropertyMeta, getJsonClassMeta, getSchemaSerializer, isAddBeanTypes, isEscapeSolidus, properties, writeArrayRecords, writeTokens

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializer

applyThrows, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, toString, write

Methods inherited from class org.apache.juneau.marshall.serializer.Serializer

createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, write, writeToString

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

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

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

isArrayRecordStreaming, writeArrayRecords

Methods inherited from interface java.util.function.Function

andThen, compose

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

isRecordStreaming

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

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

writeRecords

Field Details

DEFAULT

public static final Json5lSerializer DEFAULT

Default serializer, strict-JSON-per-line.

Constructor Details

Json5lSerializer

public Json5lSerializer(Json5lSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static Json5lSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

isJson5Sugar

public boolean isJson5Sugar()

Returns true if this serializer emits JSON5 sugar on each line.

Returns:

true if JSON5 sugar is enabled.

copy

public Json5lSerializer.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 JsonSerializer

Returns:

A new Builder object.

createSession

public Json5lSerializerSession.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 JsonlSerializer

Returns:

A new session builder.

getSession

public Json5lSerializerSession 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 JsonSerializer

Returns:

A new session object.