Package org.apache.juneau.serializer

Class OutputStreamSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.OutputStreamSerializer

All Implemented Interfaces:

AnnotationProvider

Direct Known Subclasses:

ImageSerializer, MsgPackSerializer

public class OutputStreamSerializer
extends Serializer

Subclass of Serializer for byte-based serializers.

Notes:

• This class is thread safe and reusable.

See Also:

• Serializers and Parsers

Nested Class Summary

Nested Classes

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

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

Serializer.Null

Field Summary

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DEFAULT, DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OutputStreamSerializer.Builder	create()	Creates a new builder for this object.
OutputStreamSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final BinaryFormat	getBinaryFormat()	Binary output format.
OutputStreamSerializerSession	getSession()	Returns a session to use for this context.
final boolean	isWriterSerializer()	Returns true if this serializer subclasses from WriterSerializer.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.
final byte[]	serialize(Object o)	Convenience method for serializing an object to a byte.

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

copy, createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, toString

Methods inherited from class java.lang.Object

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

Constructor Details

OutputStreamSerializer

protected OutputStreamSerializer(OutputStreamSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static OutputStreamSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

createSession

public OutputStreamSerializerSession.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 Serializer

Returns:

A new session builder.

getSession

public OutputStreamSerializerSession 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 Serializer

Returns:

A new session object.

isWriterSerializer

public final boolean isWriterSerializer()

Description copied from class: Serializer

Returns true if this serializer subclasses from WriterSerializer.

Overrides:

isWriterSerializer in class Serializer

Returns:

true if this serializer subclasses from WriterSerializer.

serialize

public final byte[] serialize(Object o)
                       throws SerializeException

Convenience method for serializing an object to a byte.

Overrides:

serialize in class Serializer

Parameters:

o - The object to serialize.

Returns:

The output serialized to a byte array.

Throws:

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

getBinaryFormat

protected final BinaryFormat getBinaryFormat()

Binary output format.

Returns:

The format to use for the Serializer.serializeToString(Object) method on stream-based serializers when converting byte arrays to strings.

See Also:

• OutputStreamSerializer.Builder.binaryFormat(BinaryFormat)

properties

protected JsonMap properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class Serializer

Returns:

The properties on this bean as a map for debugging.