Package org.apache.juneau.marshall.markdown

Class MarkdownDocSerializerSession

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.markdown.MarkdownSerializerSession

org.apache.juneau.marshall.markdown.MarkdownDocSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, RecordWritable

public class MarkdownDocSerializerSession
extends MarkdownSerializerSession

Session object for MarkdownDocSerializer.

Notes:

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.marshall.markdown.MarkdownSerializerSession

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

Method Summary

Modifier and Type	Method	Description
static MarkdownDocSerializerSession.Builder	create(MarkdownDocSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe pipe, Object o)	Serializes a POJO to the specified pipe.
protected void	writeBeanWithHeadings(MarkdownWriter w, BeanMap<?> bm, int level)	Serializes a bean in document mode, using headings to structure nested objects.

Methods inherited from class org.apache.juneau.marshall.markdown.MarkdownSerializerSession

create, getMarkdownWriter, getTableHeaders, isRecordStreaming, writeAnything, writeBeanMap, writeCollection, writeInlineValue, writeMap, writeRecords

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.commons.conversion.ConverterSession

get

Constructor Details

MarkdownDocSerializerSession

protected MarkdownDocSerializerSession(MarkdownDocSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MarkdownDocSerializerSession.Builder create(MarkdownDocSerializer 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 pipe,
 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 MarkdownSerializerSession

Parameters:

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

writeBeanWithHeadings

protected void writeBeanWithHeadings(MarkdownWriter w,
 BeanMap<?> bm,
 int level)
                              throws IOException,
SerializeException

Serializes a bean in document mode, using headings to structure nested objects.

Simple properties go into a key/value table. Nested bean, map, and collection properties get their own sub-headings.

Parameters:

w - The writer.

bm - The bean map.

level - The current heading level.

Throws:

IOException - Thrown by underlying stream.

SerializeException - If serialization fails.