Package org.apache.juneau.marshall.json5l

Class Json5lSerializerSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.serializer.SerializerSession

org.apache.juneau.marshall.serializer.WriterSerializerSession

org.apache.juneau.marshall.json.JsonSerializerSession

org.apache.juneau.marshall.jsonl.JsonlSerializerSession

org.apache.juneau.marshall.json5l.Json5lSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

public class Json5lSerializerSession
extends JsonlSerializerSession

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

Extends JsonlSerializerSession to inherit JSONL's line-delimited framing. When the owning Json5lSerializer has json5Sugar enabled, the per-line output switches to JSON5 sugar (single-quoted strings, unquoted field names where safe) on both the databind and token-streaming paths; otherwise the inherited strict RFC-8259 output is used unchanged.

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	Json5lSerializerSession.Builder	Builder class.

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

JsonSerializerSession.DefaultBuilder

Field Summary

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

indent

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

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Json5lSerializerSession(Json5lSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static Json5lSerializerSession.Builder	create(Json5lSerializer ctx)	Creates a new builder for this object.
protected JsonWriter<?>	getJsonWriter(SerializerPipe out)	Converts the specified output target object to an JsonWriter.
TokenWriter	writeTokens(Object output)	Opens a low-level push generator that emits JSONL one structural event at a time, with a trailing newline after every top-level value, bound to this live session.

Methods inherited from class org.apache.juneau.marshall.jsonl.JsonlSerializerSession

create, doWrite, writeArrayRecords

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

create, getJsonClassMeta, isAddBeanTypes, isEscapeSolidus, isSimpleAttrs, writeAnything, writeBeanMap, writeJson, writeMap

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

create, createPipe, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, write, writeToString

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

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, sort, sort, sort, swap, toList, toListFromStreamable, toString, trim, unwrapSupplier, write, writeCalendar, writeDate, writeDuration, writePeriod, writeTemporal

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

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

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, newGenericList, newGenericMap, 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.ArrayRecordWritable

isArrayRecordStreaming, writeArrayRecords

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

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

isRecordStreaming

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

writeRecords

Constructor Details

Json5lSerializerSession

protected Json5lSerializerSession(Json5lSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static Json5lSerializerSession.Builder create(Json5lSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

getJsonWriter

protected JsonWriter<?> getJsonWriter(SerializerPipe out)

Description copied from class: JsonSerializerSession

Converts the specified output target object to an JsonWriter.

Overrides:

getJsonWriter in class JsonSerializerSession

Parameters:

out - The output target object.
Must not be null.

Returns:

The output target object wrapped in an JsonWriter.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Description copied from class: JsonlSerializerSession

Opens a low-level push generator that emits JSONL one structural event at a time, with a trailing newline after every top-level value, bound to this live session.

Same honored/ignored builder properties as JsonSerializerSession.writeTokens(Object) except that useWhitespace is forced to false — pretty-printed JSONL is not standard.

Specified by:

writeTokens in interface TokenWritable

Overrides:

writeTokens in class JsonlSerializerSession

Parameters:

output - The output.

Returns:

A new JsonlTokenWriter.

Throws:

IOException - If the output type is not supported or could not be opened.