Package org.apache.juneau.marshall.serializer

Class OutputStreamSerializerSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.serializer.SerializerSession

org.apache.juneau.marshall.serializer.OutputStreamSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession

Direct Known Subclasses:

BsonSerializerSession, CborSerializerSession, MsgPackSerializerSession, ParquetSerializerSession, RdfStreamSerializerSession

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.doWrite(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<SELF extends OutputStreamSerializerSession.Builder<SELF>>	Builder class.
static final class	OutputStreamSerializerSession.DefaultBuilder	Concrete default builder leaf for the non-subclassed create() path (CRTP terminal).

Field Summary

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

indent

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

NAME_PROPERTY_NAME

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 output object into a SerializerPipe object so that it can be easily converted into a stream or writer.
protected final BinaryFormat	getBinaryFormat()	Binary output format.
boolean	hasNativeBytes()	Returns whether this binary serializer has a native byte-array wire type.
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.
final String	writeToString(Object o)	Shortcut method for serializing an object to a String.

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

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, doWrite, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddBeanTypes, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, properties, push2, relativizeUri, resolve, resolveUri, sort, sort, sort, swap, toList, toListFromStreamable, toString, trim, unwrapSupplier, write, writeCalendar, writeDate, writeDuration, writePeriod, writeTemporal

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

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

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

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

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

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

OutputStreamSerializerSession

protected OutputStreamSerializerSession(OutputStreamSerializerSession.Builder<?> builder)

Constructor.

Parameters:

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

Method Details

create

public static OutputStreamSerializerSession.Builder<?> create(OutputStreamSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

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.

write

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

Convenience method for serializing an object to a byte.

Overrides:

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

writeToString

public final String writeToString(Object o)
                           throws SerializeException

Description copied from class: SerializerSession

Shortcut method for serializing an object to a String.

Overrides:

writeToString 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 MarshallingContextable.Builder.binaryFormat(BinaryFormat) setting.

Throws:

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

createPipe

protected SerializerPipe createPipe(Object output)

Description copied from class: SerializerSession

Wraps the specified output object into a SerializerPipe object so that it can be easily converted into a stream or writer.

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.

For byte-based serializers, this must be an OutputStream.

Returns:

A new SerializerPipe wrapper around the specified output object.

getBinaryFormat

protected final BinaryFormat getBinaryFormat()

Binary output format.

Returns:

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

See Also:

• MarshallingContext.Builder.binaryFormat(BinaryFormat)

hasNativeBytes

public boolean hasNativeBytes()

Returns whether this binary serializer has a native byte-array wire type.

When true, byte[] payloads bypass the configured BinaryFormat dispatch in BinarySwap and the variant binary swap installed by MarshalledPropertyPostProcessor, and are written as raw bytes through the serializer's native binary opcode (e.g. MsgPack bin family, CBOR byte-string major type 2, BSON binary subtype 0x05). When false, the configured BinaryFormat fires for non-NOT_SET formats and produces a text wire form (HEX / BASE64 / etc.) that the serializer emits as a string in its native string column / literal type — used by serializers whose wire format has no native byte-array primitive (Parquet column writer, binary RDF formats).

Defaults to true. Subclasses without a native byte-array wire type (e.g. ParquetSerializerSession and the binary RDF sessions) override and return false.

Returns:

true if this serializer has a native byte-array wire type.