Package org.apache.juneau.marshall.serializer

Class OutputStreamSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.OutputStreamSerializer

All Implemented Interfaces:

Function<Object,byte[]>, ThrowingFunction<Object,byte[]>

Direct Known Subclasses:

BsonSerializer, CborSerializer, ImageSerializer, MsgPackSerializer, ParquetSerializer, PetPhotoSerializer, RdfStreamSerializer

public class OutputStreamSerializer
extends Serializer
implements ThrowingFunction<Object,byte[]>

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<SELF extends OutputStreamSerializer.Builder<SELF>>	Builder class.
static final class	OutputStreamSerializer.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() / Serializer.copy() path.

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

Serializer.Null

Field Summary

Fields inherited from class org.apache.juneau.marshall.serializer.Serializer

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

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

marshallingContext

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

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OutputStreamSerializer(OutputStreamSerializer.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
final byte[]	applyThrows(Object o)	Allows this serializer to be used as a ThrowingFunction that converts an object to its serialized byte array form.
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.
final byte[]	write(Object o)	Convenience method for serializing an object to a byte.

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

copy, createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, properties, write, writeToString

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

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

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

getDurationFormat, getMarshallingContext, getPeriodFormat

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

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

Constructor Details

OutputStreamSerializer

protected OutputStreamSerializer(OutputStreamSerializer.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.
Cannot be null.

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.

write

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

Convenience method for serializing an object to a byte.

Overrides:

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

applyThrows

public final byte[] applyThrows(Object o)
                         throws Exception

Allows this serializer to be used as a ThrowingFunction that converts an object to its serialized byte array form.

Because OutputStreamSerializer implements ThrowingFunction<Object,byte[]>, a serializer instance can be passed directly wherever a Function or ThrowingFunction is expected (e.g. assertion transform methods).

Specified by:

applyThrows in interface ThrowingFunction<Object,byte[]>

Parameters:

o - The object to serialize.

Returns:

The output serialized to a byte array.

Throws:

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

getBinaryFormat

protected final BinaryFormat getBinaryFormat()

Binary output format.

Resolves from the configured MarshallingContext.getBinaryFormat().

Returns:

The binary wire format used by this serializer.