Package org.apache.juneau.json

Class JsonSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.json.JsonSerializerSession

Direct Known Subclasses:

JsonSchemaSerializerSession

public class JsonSerializerSession
extends WriterSerializerSession

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 Basics

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

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	doSerialize(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 final JsonWriter	getJsonWriter(SerializerPipe out)	Converts the specified output target object to an JsonWriter.
protected final boolean	isAddBeanTypes()	Add "_type" properties when needed.
protected final boolean	isEscapeSolidus()	Prefix solidus '/' characters with escapes.
protected final boolean	isSimpleAttrs()	Simple JSON attributes.
protected JsonWriter	serializeAnything(JsonWriter out, Object o, ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta)	Workhorse method.
protected String	serializeJson(Object o)	Method that can be called from subclasses to serialize an object to JSON.

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

create, createPipe, getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, serialize, serializeToString

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

addVarBean, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getSchema, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, serialize, sort, sort, sort, swap, toList, toString, trim

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

_class, addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.

Returns:

A new builder.

doSerialize

protected void doSerialize(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.doSerialize(SerializerSession,SerializerPipe,Object).

Overrides:

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

serializeJson

protected String serializeJson(Object o)
                        throws Exception

Method that can be called from subclasses to serialize an object to JSON.

Used by JsonSchemaSerializerSession for serializing examples to JSON.

Parameters:

o - The object to serialize.

Returns:

The serialized object.

Throws:

Exception - Error occurred.

serializeAnything

protected JsonWriter serializeAnything(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.

o - The object to serialize.

eType - The expected type.

attrName - The attribute name.

pMeta - The bean property currently being parsed.

Returns:

The same writer passed in.

Throws:

SerializeException - General serialization error occurred.

getJsonWriter

protected final JsonWriter getJsonWriter(SerializerPipe out)
                                  throws IOException

Converts the specified output target object to an JsonWriter.

Parameters:

out - The output target object.

Returns:

The output target object wrapped in an JsonWriter.

Throws:

IOException - Thrown by underlying stream.

isAddBeanTypes

protected final boolean isAddBeanTypes()

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class SerializerSession

Returns:

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

See Also:

• JsonSerializer.Builder.addBeanTypesJson()

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 final boolean isSimpleAttrs()

Simple JSON attributes.

Returns:

true if JSON attribute names will only be quoted when necessary.
Otherwise, they are always quoted.

See Also:

• JsonSerializer.Builder.simpleAttrs()

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.