Package org.apache.juneau.serializer

Class OutputStreamSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.OutputStreamSerializerSession

Direct Known Subclasses:

MsgPackSerializerSession

public class OutputStreamSerializerSession
extends SerializerSession

Subclass of SerializerSession for stream-based serializers.

Description

This class is the parent class of all byte-based serializers.
It has 1 abstract method to implement...

• SerializerSession.doSerialize(SerializerPipe, Object)

Notes:

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

See Also:

• Serializers and Parsers

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OutputStreamSerializerSession.Builder	create(OutputStreamSerializer ctx)	Creates a new builder for this object.
protected SerializerPipe	createPipe(Object output)	Wraps the specified input object into a ParserPipe object so that it can be easily converted into a stream or reader.
protected final BinaryFormat	getBinaryFormat()	Binary output format.
final boolean	isWriterSerializer()	Returns true if this serializer subclasses from WriterSerializer.
final byte[]	serialize(Object o)	Convenience method for serializing an object to a byte.
final String	serializeToString(Object o)	Shortcut method for serializing an object to a String.

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

addVarBean, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, doSerialize, forEachEntry, forEachEntry, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getSchema, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddBeanTypes, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, properties, 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

OutputStreamSerializerSession

protected OutputStreamSerializerSession(OutputStreamSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static OutputStreamSerializerSession.Builder create(OutputStreamSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

isWriterSerializer

public final boolean isWriterSerializer()

Description copied from class: SerializerSession

Returns true if this serializer subclasses from WriterSerializer.

Overrides:

isWriterSerializer in class SerializerSession

Returns:

true if this serializer subclasses from WriterSerializer.

createPipe

protected SerializerPipe createPipe(Object output)

Description copied from class: SerializerSession

Wraps the specified input object into a ParserPipe object so that it can be easily converted into a stream or reader.

Overrides:

createPipe in class SerializerSession

Parameters:

output - The output location.
For character-based serializers, this can be any of the following types:

• Writer
• OutputStream - Output will be written as UTF-8 encoded stream.
• File - Output will be written as system-default encoded stream.
• StringBuilder

For byte-based serializers, this can be any of the following types:

• OutputStream
• File

Returns:

A new ParserPipe wrapper around the specified input object.

serialize

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

Convenience method for serializing an object to a byte.

Overrides:

serialize in class SerializerSession

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.

serializeToString

public final String serializeToString(Object o)
                               throws SerializeException

Description copied from class: SerializerSession

Shortcut method for serializing an object to a String.

Overrides:

serializeToString in class SerializerSession

Parameters:

o - The object to serialize.

Returns:

The serialized object.
Character-based serializers will return a String
Stream-based serializers will return a byte[] converted to a string based on the OutputStreamSerializer.Builder.binaryFormat(BinaryFormat) setting.

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 serializeToString(Object) method on stream-based serializers when converting byte arrays to strings.

See Also:

• OutputStreamSerializer.Builder.binaryFormat(BinaryFormat)