Package org.apache.juneau.marshall.yaml

Class YamlSerializerSession

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

org.apache.juneau.marshall.yaml.YamlSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable

public class YamlSerializerSession
extends WriterSerializerSession
implements RecordWritable, ArrayRecordWritable

Session object that lives for the duration of a single use of YamlSerializer.

Notes:

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

See Also:

• YAML

Nested Class Summary

Nested Classes

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

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

WriterSerializerSession.DefaultBuilder

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	YamlSerializerSession(YamlSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static YamlSerializerSession.Builder	create(YamlSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected final YamlWriter	getYamlWriter(SerializerPipe out)	Converts the specified output target object to a YamlWriter.
boolean	isArrayRecordStreaming()	The YAML array-record writer is buffered/RecordAdapter-backed, not O(1) streaming.
boolean	isRecordStreaming()	The YAML record writer is buffered/RecordAdapter-backed, not O(1) streaming.
protected YamlWriter	writeAnything(YamlWriter out, Object o, ClassMeta<?> eType, String attrName, BeanPropertyMeta pMeta, boolean asField)	Workhorse method.
RecordWriter	writeArrayRecords(Object output)	Buffered array-element RecordWriter for YAML, bound to this live session.
RecordWriter	writeRecords(Object output)	Opens a whole-value push generator targeting YAML output, bound to this live session.

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

create, createPipe, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, write, writeToString

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

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, 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, 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.marshall.stream.ArrayRecordWritable

writeArrayRecords

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

get

Constructor Details

YamlSerializerSession

protected YamlSerializerSession(YamlSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static YamlSerializerSession.Builder create(YamlSerializer ctx)

Creates a new builder for this object.

Parameters:

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

Returns:

A new builder.

doWrite

protected void doWrite(SerializerPipe out,
 Object o)
                throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doWrite(SerializerSession,SerializerPipe,Object).

Overrides:

doWrite in class SerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

writeRecords

public RecordWriter writeRecords(Object output)
                          throws IOException

Opens a whole-value push generator targeting YAML output, bound to this live session. write(Object) delegates to SerializerSession.write(Object, Object).

Specified by:

writeRecords in interface RecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Buffered array-element RecordWriter for YAML, bound to this live session. Buffers each write(...) and emits the whole list on close().

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isRecordStreaming

public boolean isRecordStreaming()

The YAML record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isRecordStreaming in interface RecordWritable

Returns:

Always false.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

The YAML array-record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isArrayRecordStreaming in interface ArrayRecordWritable

Returns:

Always false.

getYamlWriter

protected final YamlWriter getYamlWriter(SerializerPipe out)

Converts the specified output target object to a YamlWriter.

Parameters:

out - The output target object.
Must not be null.

Returns:

The output target object wrapped in a YamlWriter.

writeAnything

protected YamlWriter writeAnything(YamlWriter out,
 Object o,
 ClassMeta<?> eType,
 String attrName,
 BeanPropertyMeta pMeta,
 boolean asField)
                            throws SerializeException

Workhorse method. Determines the type of object, and then calls the appropriate type-specific serialization method.

Parameters:

out - The output writer.

o - The object to serialize.

eType - The expected type.

attrName - The attribute name.

pMeta - The bean property currently being parsed.

asField - If true, this value appears inline after a key or at root level. If false, this value needs its own indentation as a standalone block.

Returns:

The same writer passed in.

Throws:

SerializeException - General serialization error occurred.