Package org.apache.juneau.marshall.html

Class HtmlSchemaDocSerializerSession

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.xml.XmlSerializerSession

org.apache.juneau.marshall.html.HtmlSerializerSession

org.apache.juneau.marshall.html.HtmlStrippedDocSerializerSession

org.apache.juneau.marshall.html.HtmlDocSerializerSession

org.apache.juneau.marshall.html.HtmlSchemaDocSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, RecordWritable

public class HtmlSchemaDocSerializerSession
extends HtmlDocSerializerSession

Context object that lives for the duration of a single serialization of HtmlSchemaDocSerializer and its subclasses.

Notes:

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

See Also:

• HTML

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.marshall.html.HtmlDocSerializerSession

HtmlDocSerializerSession.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.xml.XmlSerializerSession

XmlSerializerSession.ContentResult

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

Method Summary

Modifier and Type	Method	Description
static HtmlSchemaDocSerializerSession.Builder	create(HtmlSchemaDocSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.

Methods inherited from class org.apache.juneau.marshall.html.HtmlDocSerializerSession

create, createDefaultVarResolverSession, forEachWidget, getAside, getAsideFloat, getFooter, getHead, getHeader, getNav, getNavlinks, getNavLinks, getNonce, getNoResultsMessage, getScript, getStyle, getStylesheet, getTemplate, isNowrap, isResolveBodyVars, parentSerialize, properties, resolveHtmlDoc, resolveScriptStyle

Methods inherited from class org.apache.juneau.marshall.html.HtmlStrippedDocSerializerSession

create

Methods inherited from class org.apache.juneau.marshall.html.HtmlSerializerSession

create, getAnchorText, getHtmlBeanPropertyMeta, getHtmlClassMeta, getHtmlWriter, getLabelParameter, getUriAnchorText, isAddBeanTypes, isAddKeyValueTableHeaders, isDetectLabelParameters, isDetectLinksInStrings, isHtmlMode, isUri, writeAnything, writeAnything

Methods inherited from class org.apache.juneau.marshall.xml.XmlSerializerSession

create, findNsfMappings, getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, getXmlWriter, isAddJsonTags, isAddNamespaceUrisToRoot, isAutoDetectNamespaces, isEnableNamespaces, isRecordStreaming, writeRecords

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

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

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

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, 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

HtmlSchemaDocSerializerSession

protected HtmlSchemaDocSerializerSession(HtmlSchemaDocSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlSchemaDocSerializerSession.Builder create(HtmlSchemaDocSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

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 HtmlDocSerializerSession

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.