org.apache.juneau.serializer

Class Serializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.serializer.Serializer

Direct Known Subclasses:

OutputStreamSerializer, WriterSerializer

public abstract class Serializer
extends BeanContext

Parent class for all Juneau serializers.

Description

Base serializer class that serves as the parent class for all serializers.

The purpose of this class is:

• Maintain a read-only configuration state of a serializer.
• Create session objects used for serializing POJOs (i.e. SerializerSession).
• Provide convenience methods for serializing POJOs without having to construct session objects.

Subclasses should extend directly from OutputStreamSerializer or WriterSerializer depending on whether it's a stream or character based serializer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZER_abridged Configuration property: Abridged output.
static String	SERIALIZER_addBeanTypeProperties Configuration property: Add "_type" properties when needed.
static String	SERIALIZER_detectRecursions Configuration property: Automatically detect POJO recursions.
static String	SERIALIZER_ignoreRecursions Configuration property: Ignore recursion errors.
static String	SERIALIZER_initialDepth Configuration property: Initial depth.
static String	SERIALIZER_listener Configuration property: Serializer listener.
static String	SERIALIZER_maxDepth Configuration property: Max serialization depth.
static String	SERIALIZER_maxIndent Configuration property: Maximum indentation.
static String	SERIALIZER_quoteChar Configuration property: Quote character.
static String	SERIALIZER_sortCollections Configuration property: Sort arrays and collections alphabetically.
static String	SERIALIZER_sortMaps Configuration property: Sort maps alphabetically.
static String	SERIALIZER_trimEmptyCollections Configuration property: Trim empty lists and arrays.
static String	SERIALIZER_trimEmptyMaps Configuration property: Trim empty maps.
static String	SERIALIZER_trimNullProperties Configuration property: Trim null bean property values.
static String	SERIALIZER_trimStrings Configuration property: Trim strings.
static String	SERIALIZER_uriContext Configuration property: URI context bean.
static String	SERIALIZER_uriRelativity Configuration property: URI relativity.
static String	SERIALIZER_uriResolution Configuration property: URI resolution.
static String	SERIALIZER_useWhitespace Configuration property: Use whitespace.

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_debug, BEAN_excludeProperties, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
SerializerBuilder	builder() Creates a builder from this context object.
SerializerSessionArgs	createDefaultSessionArgs() Defines default session arguments used when calling the Context.createSession() method.
SerializerSession	createSession() Create a new bean session based on the properties defined on this context.
abstract SerializerSession	createSession(SerializerSessionArgs args) Create the session object used for actual serialization of objects.
MediaType[]	getMediaTypes() Returns the media types handled based on the value of the accept parameter passed into the constructor.
MediaType	getResponseContentType() Optional method that returns the response Content-Type for this serializer if it is different from the matched media type.
boolean	isWriterSerializer() Returns true if this serializer subclasses from WriterSerializer.
Object	serialize(Object o) Shortcut method for serializing objects directly to either a String or byte[] depending on the serializer type.
void	serialize(Object o, Object output) Serializes a POJO to the specified output stream or writer.

Methods inherited from class org.apache.juneau.BeanContext

_class, create, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, hasSameCache, isBean, isNotABean, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZER_abridged

public static final String SERIALIZER_abridged

Configuration property: Abridged output.

Property:

• Name: "Serializer.abridged.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.abridged(boolean)
  • SerializerBuilder.abridged()

Description:

When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level type information that might normally be included to determine the data type will not be serialized.

For example, when serializing a top-level POJO with a @Bean.typeName() value, a '_type' attribute will only be added when this setting is enabled.

Note the differences between the following settings:

• SERIALIZER_abridged - Affects whether '_type' is added to root node.
• SERIALIZER_addBeanTypeProperties - Affects whether '_type' is added to any nodes.

Example:

// Create a serializer that doesn't add _type to root node. WriterSerializer s = JsonSerializer .create() .abridged() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_abridged, true) .build(); // The bean we want to serialize. @Bean(typeName="mybean") public class MyBean {...} // Will not contain '_type' attribute even though there's a type name on the bean. String json = s.serialize(new MyBean()); // '_type' wasn't needed on the parse side because we know the type being parsed. MyBean myBean = JsonParser.DEFAULT.parse(json, MyBean.class);

See Also:

Constant Field Values

SERIALIZER_addBeanTypeProperties

public static final String SERIALIZER_addBeanTypeProperties

Configuration property: Add "_type" properties when needed.

Property:

• Name: "Serializer.addBeanTypeProperties.b"
• Data type: Boolean
• Default: true
• Session-overridable: true
• Methods:
  • SerializerBuilder.addBeanTypeProperties(boolean)

Description:

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

This is used to recreate the correct objects during parsing if the object types cannot be inferred.
For example, when serializing a Map<String,Object> field where the bean class cannot be determined from the type of the values.

Note the differences between the following settings:

• SERIALIZER_abridged - Affects whether '_type' is added to root node.
• SERIALIZER_addBeanTypeProperties - Affects whether '_type' is added to any nodes.

Example:

// Create a serializer that never adds _type to nodes. WriterSerializer s = JsonSerializer .create() .addBeanTypeProperties(false) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_addBeanTypeProperties, false) .build(); // A map of objects we want to serialize. @Bean(typeName="mybean") public class MyBean {...} Map<String,Object> m = new HashMap<>(); m.put("foo", new MyBean()); // Will not contain '_type' attribute even though type name is on bean and we're serializing // a map of generic objects. String json = s.serialize(m);

See Also:

Constant Field Values

SERIALIZER_detectRecursions

public static final String SERIALIZER_detectRecursions

Configuration property: Automatically detect POJO recursions.

Property:

• Name: "Serializer.detectRecursions.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.detectRecursions(boolean)
  • SerializerBuilder.detectRecursions()

Description:

Specifies that recursions should be checked for during serialization.

Recursions can occur when serializing models that aren't true trees but rather contain loops.
In general, unchecked recursions cause stack-overflow-errors.
These show up as ParseExceptions with the message "Depth too deep. Stack overflow occurred.".

The behavior when recursions are detected depends on the value for SERIALIZER_ignoreRecursions.

For example, if a model contains the links A->B->C->A, then the JSON generated will look like the following when SERIALIZER_ignoreRecursions is true...

{A:{B:{C:null}}}

Notes:

• Checking for recursion can cause a small performance penalty.

Example:

// Create a serializer that never adds _type to nodes. WriterSerializer s = JsonSerializer .create() .detectRecursions() .ignoreRecursions() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_detectRecursions, true) .set(SERIALIZER_ignoreRecursions, true) .build(); // Create a POJO model with a recursive loop. public class A { public Object f; } A a = new A(); a.f = a; // Produces "{f:null}" String json = s.serialize(a);

See Also:

Constant Field Values

SERIALIZER_ignoreRecursions

public static final String SERIALIZER_ignoreRecursions

Configuration property: Ignore recursion errors.

Property:

• Name: "Serializer.ignoreRecursions.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.ignoreRecursions(boolean)
  • SerializerBuilder.ignoreRecursions()

Description:

Used in conjunction with SERIALIZER_detectRecursions.
Setting is ignored if SERIALIZER_detectRecursions is false.

If true, when we encounter the same object when serializing a tree, we set the value to null.
Otherwise, a SerializeException is thrown with the message "Recursion occurred, stack=...".

See Also:

Constant Field Values

SERIALIZER_initialDepth

public static final String SERIALIZER_initialDepth

Configuration property: Initial depth.

Property:

• Name: "Serializer.initialDepth.i"
• Data type: Integer
• Default: 0
• Session-overridable: true
• Methods:
  • SerializerBuilder.initialDepth(int)

Description:

The initial indentation level at the root.
Useful when constructing document fragments that need to be indented at a certain level.

Example:

// Create a serializer with whitespace enabled and an initial depth of 2. WriterSerializer s = JsonSerializer .create() .ws() .initialDepth(2) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_useWhitespace, true) .set(SERIALIZER_initialDepth, 2) .build(); // Produces "\t\t{\n\t\t\t'foo':'bar'\n\t\t}\n" String json = s.serialize(new MyBean());

See Also:

Constant Field Values

SERIALIZER_listener

public static final String SERIALIZER_listener

Configuration property: Serializer listener.

Property:

• Name: "Serializer.listener.c"
• Data type: Class<? extends SerializerListener>
• Default: null
• Session-overridable: true
• Methods:
  • SerializerBuilder.listener(Class)

Description:

Class used to listen for errors and warnings that occur during serialization.

Example:

// Define our serializer listener. // Simply captures all errors. public class MySerializerListener extends SerializerListener { // A simple property to store our events. public List<String> events = new LinkedList<>(); @Override public <T> void onError(SerializerSession session, Throwable t, String msg) { events.add(session.getLastLocation() + "," + msg + "," + t); } } // Create a serializer using our listener. WriterSerializer s = JsonSerializer. .create() .listener(MySerializerListener.class) .build(); // Same, but use property. WriterSerializer s = JsonSerializer. .create() .set(SERIALIZER_listener, MySerializerListener.class) .build(); // Create a session object. // Needed because listeners are created per-session. try (WriterSerializerSession ss = s.createSession()) { // Serialize a bean. String json = ss.serialize(new MyBean()); // Get the listener. MySerializerListener l = ss.getListener(MySerializerListener.class); // Dump the results to the console. JsonSerializer.DEFAULT_LAX.println(l.events); }

See Also:

Constant Field Values

SERIALIZER_maxDepth

public static final String SERIALIZER_maxDepth

Configuration property: Max serialization depth.

Property:

• Name: "Serializer.maxDepth.i"
• Data type: Integer
• Default: 100
• Session-overridable: true
• Methods:
  • SerializerBuilder.maxDepth(int)

Description:

Abort serialization if specified depth is reached in the POJO tree.
If this depth is exceeded, an exception is thrown.

Example:

// Create a serializer that throws an exception if the depth is greater than 20. WriterSerializer s = JsonSerializer .create() .maxDepth(20) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_maxDepth, 20) .build();

See Also:

Constant Field Values

SERIALIZER_maxIndent

public static final String SERIALIZER_maxIndent

Configuration property: Maximum indentation.

Property:

• Name: "Serializer.maxIndent.i"
• Data type: Integer
• Default: 100
• Session-overridable: true
• Methods:
  • SerializerBuilder.maxIndent(int)

Description:

Specifies the maximum indentation level in the serialized document.

This setting does not apply to the MessagePack or RDF serializers.

Example:

// Create a serializer that indents a maximum of 20 tabs. WriterSerializer s = JsonSerializer .create() .maxIndent(20) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_maxIndent, 20) .build();

See Also:

Constant Field Values

SERIALIZER_quoteChar

public static final String SERIALIZER_quoteChar

Configuration property: Quote character.

Property:

• Name: "Serializer.quoteChar.s"
• Data type: String
• Default: "\""
• Session-overridable: true
• Methods:
  • SerializerBuilder.quoteChar(char)
  • SerializerBuilder.sq()

Description:

This is the character used for quoting attributes and values.

This setting does not apply to the MessagePack or RDF serializers.

Example:

// Create a serializer that uses single quotes. WriterSerializer s = JsonSerializer .create() .sq() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_quoteChar, '\'') .build();

See Also:

Constant Field Values

SERIALIZER_sortCollections

public static final String SERIALIZER_sortCollections

Configuration property: Sort arrays and collections alphabetically.

Property:

• Name: "Serializer.sortCollections.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.sortCollections(boolean)
  • SerializerBuilder.sortCollections()

Description:

Copies and sorts the contents of arrays and collections before serializing them.

Note that this introduces a performance penalty.

Example:

// Create a serializer that sorts arrays and collections before serialization. WriterSerializer s = JsonSerializer .create() .sortCollections() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_sortCollections, true) .build();

See Also:

Constant Field Values

SERIALIZER_sortMaps

public static final String SERIALIZER_sortMaps

Configuration property: Sort maps alphabetically.

Property:

• Name: "Serializer.sortMaps.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.sortMaps(boolean)
  • SerializerBuilder.sortMaps()

Description:

Copies and sorts the contents of maps by their keys before serializing them.

Note that this introduces a performance penalty.

Example:

// Create a serializer that sorts maps before serialization. WriterSerializer s = JsonSerializer .create() .sortMaps() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_sortMaps, true) .build();

See Also:

Constant Field Values

SERIALIZER_trimEmptyCollections

public static final String SERIALIZER_trimEmptyCollections

Configuration property: Trim empty lists and arrays.

Property:

• Name: "Serializer.trimEmptyCollections.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.trimEmptyCollections(boolean)
  • SerializerBuilder.trimEmptyCollections()

Description:

If true, empty lists and arrays will not be serialized.

Note that enabling this setting has the following effects on parsing:

• Map entries with empty list values will be lost.
• Bean properties with empty list values will not be set.

Example:

// Create a serializer that skips empty arrays and collections. WriterSerializer s = JsonSerializer .create() .trimEmptyCollections() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_trimEmptyCollections, true) .build();

See Also:

Constant Field Values

SERIALIZER_trimEmptyMaps

public static final String SERIALIZER_trimEmptyMaps

Configuration property: Trim empty maps.

Property:

• Name: "Serializer.trimEmptyMaps.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.trimEmptyMaps(boolean)
  • SerializerBuilder.trimEmptyMaps()

Description:

If true, empty map values will not be serialized to the output.

Note that enabling this setting has the following effects on parsing:

• Bean properties with empty map values will not be set.

Example:

// Create a serializer that skips empty maps. WriterSerializer s = JsonSerializer .create() .trimEmptyMaps() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_trimEmptyMaps, true) .build();

See Also:

Constant Field Values

SERIALIZER_trimNullProperties

public static final String SERIALIZER_trimNullProperties

Configuration property: Trim null bean property values.

Property:

• Name: "Serializer.trimNullProperties.b"
• Data type: Boolean
• Default: true
• Session-overridable: true
• Methods:
  • SerializerBuilder.trimNullProperties(boolean)

Description:

If true, null bean values will not be serialized to the output.

Note that enabling this setting has the following effects on parsing:

• Map entries with null values will be lost.

Example:

// Create a serializer that serializes null properties. WriterSerializer s = JsonSerializer .create() .trimNullProperties(false) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_trimNullProperties, false) .build();

See Also:

Constant Field Values

SERIALIZER_trimStrings

public static final String SERIALIZER_trimStrings

Configuration property: Trim strings.

Property:

• Name: "Serializer.trimStrings.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.trimStrings(boolean)
  • SerializerBuilder.trimStrings()

Description:

If true, string values will be trimmed of whitespace using String.trim() before being serialized.

Example:

// Create a serializer that trims strings before serialization. WriterSerializer s = JsonSerializer .create() .trimStrings() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_trimStrings, true) .build(); Map<String,String> m = new HashMap<>(); m.put(" foo ", " bar "); // Produces "{foo:'bar'}" String json = JsonSerializer.DEFAULT_LAX.toString(m);

See Also:

Constant Field Values

SERIALIZER_uriContext

public static final String SERIALIZER_uriContext

Configuration property: URI context bean.

Property:

• Name: "Serializer.uriContext.s"
• Data type: String (JSON object representing a UriContext)
• Default: "{}"
• Session-overridable: true
• Methods:
  • SerializerBuilder.uriContext(UriContext)
  • SerializerBuilder.uriContext(String)

Description:

Bean used for resolution of URIs to absolute or root-relative form.

Example:

// Our URI contextual information. String authority = "http://localhost:10000"; String contextRoot = "/myContext"; String servletPath = "/myServlet"; String pathInfo = "/foo"; // Create a UriContext object. UriContext uriContext = new UriContext(authority, contextRoot, servletPath, pathInfo); // Associate it with our serializer. WriterSerializer s = JsonSerializer .create() .uriContext(uriContext) .build(); // Same, but specify as a JSON string. WriterSerializer s = JsonSerializer .create() .uriContext("{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}") .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_uriContext, uriContext) .build(); // Same, but define it on the session args instead. SerializerSessionArgs sessionArgs = new SerializerSessionArgs().uriContext(uriContext); try (WriterSerializerSession session = s.createSession(sessionArgs)) { ... }

See Also:

• Overview > juneau-marshall > URIs

See Also:

Constant Field Values

SERIALIZER_uriRelativity

public static final String SERIALIZER_uriRelativity

Configuration property: URI relativity.

Property:

• Name: "Serializer.uriRelativity.s"
• Data type: String (UriRelativity)
• Default: "RESOURCE"
• Session-overridable: true
• Methods:
  • SerializerBuilder.uriRelativity(UriRelativity)
  • SerializerBuilder.uriRelativity(String)

Description:

Defines what relative URIs are relative to when serializing any of the following:

• URI
• URL
• Properties and classes annotated with @URI

Possible values are:

• UriRelativity.RESOURCE - Relative URIs should be considered relative to the servlet URI.
• UriRelativity.PATH_INFO - Relative URIs should be considered relative to the request URI.

Example:

// Define a serializer that converts resource-relative URIs to absolute form. WriterSerializer s = JsonSerializer .create() .uriContext("{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}") .uriResolution(ABSOLUTE) .uriRelativity(RESOURCE) .build();

See Also:

• Overview > juneau-marshall > URIs

See Also:

Constant Field Values

SERIALIZER_uriResolution

public static final String SERIALIZER_uriResolution

Configuration property: URI resolution.

Property:

• Name: "Serializer.uriResolution.s"
• Data type: String (UriResolution)
• Default: "NONE"
• Session-overridable: true
• Methods:
  • SerializerBuilder.uriResolution(UriResolution)
  • SerializerBuilder.uriResolution(String)

Description:

Defines the resolution level for URIs when serializing any of the following:

• URI
• URL
• Properties and classes annotated with @URI

Possible values are:

• UriResolution.ABSOLUTE - Resolve to an absolute URL (e.g. "http://host:port/context-root/servlet-path/path-info").
• UriResolution.ROOT_RELATIVE - Resolve to a root-relative URL (e.g. "/context-root/servlet-path/path-info").
• UriResolution.NONE - Don't do any URL resolution.

Example:

// Define a serializer that converts resource-relative URIs to absolute form. WriterSerializer s = JsonSerializer .create() .uriContext("{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}") .uriResolution(ABSOLUTE) .uriRelativity(RESOURCE) .build();

See Also:

• Overview > juneau-marshall > URIs

See Also:

Constant Field Values

SERIALIZER_useWhitespace

public static final String SERIALIZER_useWhitespace

Configuration property: Use whitespace.

Property:

• Name: "Serializer.useWhitespace.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • SerializerBuilder.useWhitespace(boolean)
  • SerializerBuilder.useWhitespace()
  • SerializerBuilder.ws()

Description:

If true, whitespace is added to the output to improve readability.

This setting does not apply to the MessagePack serializer.

Example:

// Create a serializer with whitespace enabled. WriterSerializer s = JsonSerializer .create() .ws() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(SERIALIZER_useWhitespace, true) .build(); // Produces "\{\n\t'foo': 'bar'\n\}\n" String json = s.serialize(new MyBean());

See Also:

Constant Field Values

Method Detail

builder

public SerializerBuilder builder()

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:

builder in class BeanContext

Returns:

A new ContextBuilder object.

isWriterSerializer

public boolean isWriterSerializer()

Returns true if this serializer subclasses from WriterSerializer.

Returns:

true if this serializer subclasses from WriterSerializer.

createSession

public abstract SerializerSession createSession(SerializerSessionArgs args)

Create the session object used for actual serialization of objects.

Parameters:

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Returns:

The new session object.

createSession

public final SerializerSession createSession()

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class BeanContext

Returns:

A new session object.

createDefaultSessionArgs

public final SerializerSessionArgs createDefaultSessionArgs()

Description copied from class: Context

Defines default session arguments used when calling the Context.createSession() method.

Overrides:

createDefaultSessionArgs in class BeanContext

Returns:

A SessionArgs object, possibly a read-only reusable instance.

serialize

public final void serialize(Object o,
                            Object output)
                     throws SerializeException

Serializes a POJO to the specified output stream or writer.

Equivalent to calling serializer.createSession().serialize(o, output);

Parameters:

o - The object to serialize.

output - The output object.
Character-based serializers can handle the following output class types:

• Writer
• OutputStream - Output will be written as UTF-8 encoded stream.
• File - Output will be written as system-default encoded stream.
• StringBuilder - Output will be written to the specified string builder.

Stream-based serializers can handle the following output class types:

• OutputStream
• File

Throws:

SerializeException - If a problem occurred trying to convert the output.

serialize

public Object serialize(Object o)
                 throws SerializeException

Shortcut method for serializing objects directly to either a String or byte[] depending on the serializer type.

Parameters:

o - The object to serialize.

Returns:

The serialized object.
Character-based serializers will return a String
Stream-based serializers will return a byte[]

Throws:

SerializeException - If a problem occurred trying to convert the output.

getMediaTypes

public final MediaType[] getMediaTypes()

Returns the media types handled based on the value of the accept parameter passed into the constructor.

Returns:

The list of media types. Never null.

getResponseContentType

public final MediaType getResponseContentType()

Optional method that returns the response Content-Type for this serializer if it is different from the matched media type.

This method is specified to override the content type for this serializer. For example, the JsonSerializer.Simple class returns that it handles media type "text/json+simple", but returns "text/json" as the actual content type. This allows clients to request specific 'flavors' of content using specialized Accept header values.

This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server or client).

Returns:

The response content type. If null, then the matched media type is used.

asMap

public ObjectMap asMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

asMap in class BeanContext

Returns:

A new map containing the properties defined on this context.