org.apache.juneau.html

Class HtmlSerializerSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.serializer.SerializerSession

org.apache.juneau.serializer.WriterSerializerSession

org.apache.juneau.xml.XmlSerializerSession

org.apache.juneau.html.HtmlSerializerSession

Direct Known Subclasses:

HtmlSchemaSerializerSession, 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.

Nested Class Summary

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

XmlSerializerSession.ContentResult

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

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
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 HtmlBeanPropertyMeta	getHtmlBeanPropertyMeta(BeanPropertyMeta bpm) Returns the language-specific metadata on the specified bean property.
protected HtmlClassMeta	getHtmlClassMeta(ClassMeta<?> cm) Returns the language-specific metadata on the specified class.
protected HtmlWriter	getHtmlWriter(SerializerPipe out) Converts the specified output target object to an HtmlWriter.
protected String	getLabelParameter() Configuration property: Link label parameter name.
protected AnchorText	getUriAnchorText() Configuration property: Anchor text source.
protected boolean	isAddBeanTypes() Configuration property: Add "_type" properties when needed.
protected boolean	isAddKeyValueTableHeaders() Configuration property: Add key/value headers on bean/map tables.
protected boolean	isDetectLabelParameters() Configuration property: Look for link labels in URIs.
protected boolean	isDetectLinksInStrings() Configuration property: Look for URLs in Strings.
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 XmlSerializerSession.ContentResult	serializeAnything(XmlWriter out, Object o, ClassMeta<?> eType, String name, BeanPropertyMeta pMeta, int xIndent, boolean isRoot, boolean nlIfElement) Serialize the specified object to the specified writer.
protected XmlSerializerSession.ContentResult	serializeAnything(XmlWriter out, Object o, ClassMeta<?> eType, String elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixed, boolean preserveWhitespace, BeanPropertyMeta pMeta) Workhorse method.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

findNsfMappings, getDefaultNamespace, getNamespaces, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, getXmlWriter, getXsNamespace, isAddNamespaceUrisToRoot, isAutoDetectNamespaces, isEnableNamespaces

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

createPipe, getMaxIndent, getQuoteChar, isUseWhitespace, isWriterSerializer, serialize, serializeToString

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

canIgnoreValue, createBeanTypeNameProperty, createDefaultVarResolverSession, generalize, getBeanTypeName, getExpectedRootType, getJavaMethod, getListener, getListener, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, isAddRootType, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimNullProperties, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, serialize, sort, sort, swap, toList, toString, trim, varSessionObject

Methods inherited from class org.apache.juneau.BeanTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, pop, push, setCurrentClass, setCurrentProperty, willRecurse

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, 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, hasProperty, 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

getHtmlWriter

protected final HtmlWriter getHtmlWriter(SerializerPipe out)
                                  throws IOException

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:

IOException - Thrown by underlying stream.

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.

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 IOException,
                           SerializeException

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:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.

serializeAnything

protected XmlSerializerSession.ContentResult serializeAnything(XmlWriter out,
                                                               Object o,
                                                               ClassMeta<?> eType,
                                                               String elementName,
                                                               Namespace elementNamespace,
                                                               boolean addNamespaceUris,
                                                               XmlFormat format,
                                                               boolean isMixed,
                                                               boolean preserveWhitespace,
                                                               BeanPropertyMeta pMeta)
                                                        throws IOException,
                                                               SerializeException

Description copied from class: XmlSerializerSession

Workhorse method.

Overrides:

serializeAnything in class XmlSerializerSession

Parameters:

out - The writer to send the output to.

o - The object to serialize.

eType - The expected type if this is a bean property value being serialized.

elementName - The root element name.

elementNamespace - The namespace of the element.

addNamespaceUris - Flag indicating that namespace URIs need to be added.

format - The format to serialize the output to.

isMixed - We're serializing mixed content, so don't use whitespace.

preserveWhitespace - true if we're serializing XmlFormat.MIXED_PWS or XmlFormat.TEXT_PWS.

pMeta - The bean property metadata if this is a bean property being serialized.

Returns:

The same writer passed in so that calls to the writer can be chained.

Throws:

IOException - Thrown by underlying stream.

SerializeException - General serialization error occurred.

serializeAnything

protected XmlSerializerSession.ContentResult serializeAnything(XmlWriter out,
                                                               Object o,
                                                               ClassMeta<?> eType,
                                                               String name,
                                                               BeanPropertyMeta pMeta,
                                                               int xIndent,
                                                               boolean isRoot,
                                                               boolean nlIfElement)
                                                        throws IOException,
                                                               SerializeException

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

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

xIndent - The current indentation value.

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

nlIfElement - true if we should add a newline to the output before serializing only if the object is an element and not text.

Returns:

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

Throws:

IOException - Thrown by underlying stream.

SerializeException - Generic serialization error occurred.

isAddBeanTypes

protected final boolean isAddBeanTypes()

Configuration property: Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class XmlSerializerSession

Returns:

true if "_type" properties will be added to beans if their type cannot be inferred through reflection.

See Also:

HtmlSerializer.HTML_addBeanTypes

isAddKeyValueTableHeaders

protected final boolean isAddKeyValueTableHeaders()

Configuration property: Add key/value headers on bean/map tables.

Returns:

true if key and value column headers are added to tables.

See Also:

HtmlSerializer.HTML_addKeyValueTableHeaders

isDetectLabelParameters

protected final boolean isDetectLabelParameters()

Configuration property: Look for link labels in URIs.

Returns:

true if we should look for URL label parameters (e.g. "?label=foobar").

See Also:

HtmlSerializer.HTML_detectLabelParameters

isDetectLinksInStrings

protected final boolean isDetectLinksInStrings()

Configuration property: Look for URLs in Strings.

Returns:

true if we should automatically convert strings to URLs if they look like a URL.

See Also:

HtmlSerializer.HTML_detectLinksInStrings

getLabelParameter

protected final String getLabelParameter()

Configuration property: Link label parameter name.

Returns:

The parameter name to look for when resolving link labels via HtmlSerializer.HTML_detectLabelParameters.

See Also:

HtmlSerializer.HTML_labelParameter

getUriAnchorText

protected final AnchorText getUriAnchorText()

Configuration property: Anchor text source.

Returns:

When creating anchor tags (e.g. <a href='...' >text</a>) in HTML, this setting defines what to set the inner text to.

See Also:

HtmlSerializer.HTML_uriAnchorText

getHtmlClassMeta

protected HtmlClassMeta getHtmlClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getHtmlBeanPropertyMeta

protected HtmlBeanPropertyMeta getHtmlBeanPropertyMeta(BeanPropertyMeta bpm)

Returns the language-specific metadata on the specified bean property.

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

toMap

public ObjectMap toMap()

Description copied from class: Session

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

Overrides:

toMap in class XmlSerializerSession

Returns:

A new map containing the properties defined on this context.