Package org.apache.juneau.marshall.json

Class JsonSerializerSession

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

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

Direct Known Subclasses:

JcsSerializerSession, Json5SerializerSession, JsonlSerializerSession, JsonSchemaSerializerSession

public class JsonSerializerSession
extends WriterSerializerSession
implements TokenWritable, ArrayRecordWritable

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

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• JSON

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonSerializerSession.Builder<SELF extends JsonSerializerSession.Builder<SELF>>	Builder class.
static final class	JsonSerializerSession.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() path (CRTP terminal).

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

Method Summary

Modifier and Type	Method	Description
static JsonSerializerSession.Builder<?>	create(JsonSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected JsonClassMeta	getJsonClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected JsonWriter<?>	getJsonWriter(SerializerPipe out)	Converts the specified output target object to an JsonWriter.
final boolean	isAddBeanTypes()	Add "_type" properties when needed.
protected final boolean	isEscapeSolidus()	Prefix solidus '/' characters with escapes.
protected boolean	isSimpleAttrs()	Whether the token writer emits unquoted (simple) attribute names.
protected JsonWriter<?>	writeAnything(JsonWriter<?> out, Object o, ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta)	Workhorse method.
RecordWriter	writeArrayRecords(Object output)	Streaming array-element RecordWriter backed by JsonTokenWriter.
protected SerializerWriter<?>	writeBeanMap(JsonWriter<?> out, BeanMap<?> m, String typeName)
protected String	writeJson(Object o)	Serializes an object to a JSON string using this session's configuration.
protected SerializerWriter<?>	writeMap(JsonWriter<?> out, Map m, ClassMeta<?> type)
TokenWriter	writeTokens(Object output)	Opens a low-level push generator that emits JSON one structural event at a time, bound to this session's live config.

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

JsonSerializerSession

protected JsonSerializerSession(JsonSerializerSession.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JsonSerializerSession.Builder<?> create(JsonSerializer ctx)

Creates a new builder for this object.

Parameters:

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

Returns:

A new builder.

writeBeanMap

protected SerializerWriter<?> writeBeanMap(JsonWriter<?> out,
 BeanMap<?> m,
 String typeName)
                                    throws SerializeException

Throws:

SerializeException

writeMap

protected SerializerWriter<?> writeMap(JsonWriter<?> out,
 Map m,
 ClassMeta<?> type)
                                throws SerializeException

Throws:

SerializeException

doWrite

protected void doWrite(SerializerPipe out,
 Object o)
                throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doWrite(SerializerSession,SerializerPipe,Object).

Overrides:

doWrite in class SerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

getJsonClassMeta

protected JsonClassMeta getJsonClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getJsonWriter

protected JsonWriter<?> getJsonWriter(SerializerPipe out)

Converts the specified output target object to an JsonWriter.

Parameters:

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

Returns:

The output target object wrapped in an JsonWriter.

isAddBeanTypes

public final boolean isAddBeanTypes()

Description copied from class: SerializerSession

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class SerializerSession

Returns:

true if "_type" properties added to beans if their type cannot be inferred through reflection.

See Also:

• Serializer.Builder.addBeanTypes()

isEscapeSolidus

protected final boolean isEscapeSolidus()

Prefix solidus '/' characters with escapes.

Returns:

true if solidus (e.g. slash) characters should be escaped.

See Also:

• JsonSerializer.Builder.escapeSolidus()

isSimpleAttrs

protected boolean isSimpleAttrs()

Whether the token writer emits unquoted (simple) attribute names.

Returns:

false for RFC-8259 strict JSON; JSON5 overrides to true.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Opens a low-level push generator that emits JSON one structural event at a time, bound to this session's live config.

The writer is purely structural — object swaps and @Schema annotations are not applied at this layer. See TokenWriter for the contract. The higher-level TokenWriter.object(Object) bridge walks an arbitrary POJO via PojoWalker and DOES honor the databind settings (keepNullProperties, trimEmptyMaps, trimEmptyCollections, sortMaps, sortCollections, trimStrings).

Specified by:

writeTokens in interface TokenWritable

Parameters:

output - The output. Accepts Writer or OutputStream.

Returns:

A new JsonTokenWriter.

Throws:

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

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Streaming array-element RecordWriter backed by JsonTokenWriter. Memory is O(1) in the array length — elements are emitted as they arrive.

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A new element-streamed RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

writeAnything

protected JsonWriter<?> writeAnything(JsonWriter<?> out,
 Object o,
 ClassMeta<?> eType,
 String attrName,
 BeanPropertyMeta pMeta)
                               throws SerializeException

Workhorse method. Determines the type of object, and then calls the appropriate type-specific serialization method.

Parameters:

out - The output writer.
Must not be null.

o - The object to serialize.
Can be null (written as the JSON literal "null").

eType - The expected type.
Can be null (defaults to Object).

attrName - The attribute name.

pMeta - The bean property currently being serialized.
Can be null (the bean-property-level dictionary lookup and URI detection are skipped).

Returns:

The same writer passed in.

Throws:

SerializeException - General serialization error occurred.

writeJson

protected String writeJson(Object o)
                    throws Exception

Serializes an object to a JSON string using this session's configuration.

Protected extension hook that subclasses can call or override when they need to serialize a value to JSON (e.g. for embedding a nested JSON fragment).

Parameters:

o - The object to serialize.

Returns:

The serialized object.

Throws:

Exception - Error occurred.