Package org.apache.juneau.marshall.json5

Class Json5Serializer

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.json5.Json5Serializer

All Implemented Interfaces:

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

Direct Known Subclasses:

Json5Serializer.Readable

public class Json5Serializer
extends JsonSerializer

Serializes POJO models to Simplified JSON.

Media types

Handles Accept types: application/json, text/json

Produces Content-Type types: application/json5

Description

This is a JSON serializer that uses simplified notation:

• Lax quoting of JSON attribute names.
• Single quotes.

Example output (Map of name/age):

{name:"Alice",age:30}

Complex (nested object + array):

{name:"Alice",age:30,address:{street:"123 Main St",city:"Boston",state:"MA"},tags:["a","b","c"]}

Notes:

• This class is thread safe and reusable.

See Also:

• JSON

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Json5Serializer.Builder	Builder class.
static class	Json5Serializer.Readable	Default serializer, single quotes, simple mode, with whitespace.

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

JsonSerializer.DefaultBuilder

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

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final Json5Serializer	DEFAULT	Default serializer, single quotes.
static final Json5Serializer	DEFAULT_READABLE	Default serializer, single quotes, with whitespace.

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

addBeanTypesJson, 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
Json5Serializer(JsonSerializer.Builder<?> builder)	Constructor.
Json5Serializer(Json5Serializer.Builder builder)	Constructor.

Method Summary

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

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 Json5Serializer DEFAULT

Default serializer, single quotes.

DEFAULT_READABLE

public static final Json5Serializer DEFAULT_READABLE

Default serializer, single quotes, with whitespace.

Constructor Details

Json5Serializer

public Json5Serializer(Json5Serializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Json5Serializer

public Json5Serializer(JsonSerializer.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static Json5Serializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public Json5Serializer.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 Json5SerializerSession.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 JsonSerializer

Returns:

A new session builder.

getSession

public Json5SerializerSession 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.