org.apache.juneau.html

Class HtmlDocSerializerSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.xml.XmlSerializerSession

org.apache.juneau.html.HtmlSerializerSession

org.apache.juneau.html.HtmlStrippedDocSerializerSession

org.apache.juneau.html.HtmlDocSerializerSession

Direct Known Subclasses:

HtmlSchemaDocSerializerSession

public class HtmlDocSerializerSession
extends HtmlStrippedDocSerializerSession

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

See Serializer for details.

This class is NOT thread safe. It is meant to be discarded after one-time use.

Field Summary

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

indent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HtmlDocSerializerSession(HtmlDocSerializer ctx, SerializerSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
ObjectMap	asMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
protected void	doSerialize(SerializerPipe out, Object o) Serializes a POJO to the specified output stream or writer.
String[]	getAside() Returns the HtmlDocSerializer.HTMLDOC_aside setting value in this context.
String[]	getFooter() Returns the HtmlDocSerializer.HTMLDOC_footer setting value in this context.
String[]	getHead() Returns the HtmlDocSerializer.HTMLDOC_head setting value in this context.
String[]	getHeader() Returns the HtmlDocSerializer.HTMLDOC_header setting value in this context.
String[]	getNav() Returns the HtmlDocSerializer.HTMLDOC_nav setting value in this context.
String[]	getNavLinks() Returns the HtmlDocSerializer.HTMLDOC_navlinks setting value in this context.
String	getNoResultsMessage() Returns the HtmlDocSerializer.HTMLDOC_noResultsMessage setting value in this context.
Set<String>	getScript() Returns the HtmlDocSerializer.HTMLDOC_script setting value in this context.
Set<String>	getStyle() Returns the HtmlDocSerializer.HTMLDOC_style setting value in this context.
Set<String>	getStylesheet() Returns the HtmlDocSerializer.HTMLDOC_stylesheet setting value in this context.
HtmlDocTemplate	getTemplate() Returns the template to use for generating the HTML page.
boolean	isNoWrap() Returns the HtmlDocSerializer.HTMLDOC_nowrap setting value in this context.
void	parentSerialize(Object out, Object o) Calls the parent doSerialize(SerializerPipe, Object) method which invokes just the HTML serializer.

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

getAnchorText, getHtmlWriter, isAddBeanTypeProperties, isAddKeyValueTableHeaders, isHtmlMode, isUri, serializeAnything

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

findNsfMappings, getXmlWriter, serializeAnything

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

isWriterSerializer, serialize

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

canIgnoreValue, createBeanTypeNameProperty, createPipe, generalize, getBeanTypeName, getExpectedRootType, getInitialDepth, getJavaMethod, getLastLocation, getListener, getListener, getMaxDepth, getMaxIndent, getQuoteChar, getResponseHeaders, getUriResolver, isDetectRecursions, isIgnoreRecursions, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNulls, isTrimStrings, isUseWhitespace, onBeanGetterException, onError, pop, push, relativizeUri, resolveUri, serialize, setCurrentClass, setCurrentProperty, sort, sort, toList, toString, trim, willRecurse

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getStringBuilder, getTimeZone, isBean, isBean, isDebug, isIgnoreUnknownBeanProperties, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlDocSerializerSession

protected HtmlDocSerializerSession(HtmlDocSerializer ctx,
                                   SerializerSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime arguments.

Method Detail

asMap

public ObjectMap asMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

asMap in class HtmlSerializerSession

Returns:

A new map containing the properties defined on this context.

getStyle

public final Set<String> getStyle()

Returns the HtmlDocSerializer.HTMLDOC_style setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_style setting value in this context. An empty array if not specified. Never null.

getStylesheet

public final Set<String> getStylesheet()

Returns the HtmlDocSerializer.HTMLDOC_stylesheet setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_stylesheet setting value in this context. An empty array if not specified. Never null.

getScript

public final Set<String> getScript()

Returns the HtmlDocSerializer.HTMLDOC_script setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_script setting value in this context. An empty array if not specified. Never null.

getHead

public final String[] getHead()

Returns the HtmlDocSerializer.HTMLDOC_head setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_head setting value in this context. An empty array if not specified. Never null.

isNoWrap

public final boolean isNoWrap()

Returns the HtmlDocSerializer.HTMLDOC_nowrap setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_nowrap setting value in this context.

getHeader

public final String[] getHeader()

Returns the HtmlDocSerializer.HTMLDOC_header setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_header setting value in this context. null if not specified. Never an empty string.

getNavLinks

public final String[] getNavLinks()

Returns the HtmlDocSerializer.HTMLDOC_navlinks setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_navlinks setting value in this context. null if not specified. Never an empty map.

getTemplate

public final HtmlDocTemplate getTemplate()

Returns the template to use for generating the HTML page.

Returns:

The HTML page generator. Never null.

getNav

public final String[] getNav()

Returns the HtmlDocSerializer.HTMLDOC_nav setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_nav setting value in this context. null if not specified. Never an empty string.

getAside

public final String[] getAside()

Returns the HtmlDocSerializer.HTMLDOC_aside setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_aside setting value in this context. null if not specified. Never an empty string.

getFooter

public final String[] getFooter()

Returns the HtmlDocSerializer.HTMLDOC_footer setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_footer setting value in this context. null if not specified. Never an empty string.

getNoResultsMessage

public final String getNoResultsMessage()

Returns the HtmlDocSerializer.HTMLDOC_noResultsMessage setting value in this context.

Returns:

The HtmlDocSerializer.HTMLDOC_noResultsMessage setting value in this context. null if not specified. Never an empty string.

doSerialize

protected void doSerialize(SerializerPipe out,
                           Object o)
                    throws Exception

Description copied from class: SerializerSession

Serializes a POJO to the specified output stream or writer.

This method should NOT close the context object.

Overrides:

doSerialize in class HtmlStrippedDocSerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

parentSerialize

public void parentSerialize(Object out,
                            Object o)
                     throws Exception

Calls the parent doSerialize(SerializerPipe, Object) method which invokes just the HTML serializer.

Parameters:

out - Where to send the output from the serializer.

o - The object being serialized.

Throws:

Exception