org.apache.juneau.html

Class HtmlSerializerSession

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

Direct Known Subclasses:

HtmlStrippedDocSerializerSession

public class HtmlSerializerSession
extends XmlSerializerSession

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

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused within the same thread.

Field Summary

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

indent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HtmlSerializerSession(HtmlSerializer 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	getAnchorText(BeanPropertyMeta pMeta, Object o) Returns the anchor text to use for the specified URL object.
protected HtmlWriter	getHtmlWriter(SerializerPipe out) Converts the specified output target object to an HtmlWriter.
boolean	isAddBeanTypeProperties() Returns the HtmlSerializer.HTML_addBeanTypeProperties setting value for this session.
boolean	isAddKeyValueTableHeaders() Returns the HtmlSerializer.HTML_addKeyValueTableHeaders setting value for this session.
boolean	isHtmlMode() Returns true if we're serializing HTML.
boolean	isUri(ClassMeta<?> cm, BeanPropertyMeta pMeta, Object o) Returns true if the specified object is a URL.
protected org.apache.juneau.html.HtmlSerializerSession.ContentResult	serializeAnything(HtmlWriter out, Object o, ClassMeta<?> eType, String name, int xIndent, BeanPropertyMeta pMeta, boolean isRoot) Serialize the specified object to the specified writer.

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

HtmlSerializerSession

protected HtmlSerializerSession(HtmlSerializer 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. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

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 XmlSerializerSession

Returns:

A new map containing the properties defined on this context.

getHtmlWriter

protected final HtmlWriter getHtmlWriter(SerializerPipe out)
                                  throws Exception

Converts the specified output target object to an HtmlWriter.

Parameters:

out - The output target object.

Returns:

The output target object wrapped in an HtmlWriter.

Throws:

Exception

isUri

public boolean isUri(ClassMeta<?> cm,
                     BeanPropertyMeta pMeta,
                     Object o)

Returns true if the specified object is a URL.

Parameters:

cm - The ClassMeta of the object being serialized.

pMeta - The property metadata of the bean property of the object. Can be null if the object isn't from a bean property.

o - The object.

Returns:

true if the specified object is a URL.

getAnchorText

public String getAnchorText(BeanPropertyMeta pMeta,
                            Object o)

Returns the anchor text to use for the specified URL object.

Parameters:

pMeta - The property metadata of the bean property of the object. Can be null if the object isn't from a bean property.

o - The URL object.

Returns:

The anchor text to use for the specified URL object.

isAddKeyValueTableHeaders

public final boolean isAddKeyValueTableHeaders()

Returns the HtmlSerializer.HTML_addKeyValueTableHeaders setting value for this session.

Returns:

The HtmlSerializer.HTML_addKeyValueTableHeaders setting value for this session.

isAddBeanTypeProperties

public final boolean isAddBeanTypeProperties()

Returns the HtmlSerializer.HTML_addBeanTypeProperties setting value for this session.

Overrides:

isAddBeanTypeProperties in class XmlSerializerSession

Returns:

The HtmlSerializer.HTML_addBeanTypeProperties setting value for this session.

isHtmlMode

public boolean isHtmlMode()

Description copied from class: XmlSerializerSession

Returns true if we're serializing HTML.

The difference in behavior is how empty non-void elements are handled. The XML serializer will produce a collapsed tag, whereas the HTML serializer will produce a start and end tag.

Overrides:

isHtmlMode in class XmlSerializerSession

Returns:

true if we're generating HTML.

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 XmlSerializerSession

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.

serializeAnything

protected org.apache.juneau.html.HtmlSerializerSession.ContentResult serializeAnything(HtmlWriter out,
                                                                                       Object o,
                                                                                       ClassMeta<?> eType,
                                                                                       String name,
                                                                                       int xIndent,
                                                                                       BeanPropertyMeta pMeta,
                                                                                       boolean isRoot)
                                                                                throws Exception

Serialize the specified object to the specified writer.

Parameters:

out - The writer.

o - The object to serialize.

eType - The expected type of the object if this is a bean property.

name - The attribute name of this object if this object was a field in a JSON object (i.e. key of a Map.Entry or property name of a bean).

xIndent - The current indentation value.

pMeta - The bean property being serialized, or null if we're not serializing a bean property.

isRoot - true if this is the root element of the document.

Returns:

The type of content encountered. Either simple (no whitespace) or normal (elements with whitespace).

Throws:

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