Package org.apache.juneau.html

Class HtmlSerializerSession

java.lang.Object

org.apache.juneau.ContextSession

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.

Notes:

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

See Also:

• HTML Details

Nested Class Summary

Nested Classes

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

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	Description
protected	HtmlSerializerSession(HtmlSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static HtmlSerializerSession.Builder	create(HtmlSerializer ctx)	Creates a new builder for this object.
protected void	doSerialize(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
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 final HtmlWriter	getHtmlWriter(SerializerPipe out)	Converts the specified output target object to an HtmlWriter.
protected final String	getLabelParameter()	Link label parameter name.
protected final AnchorText	getUriAnchorText()	Anchor text source.
protected final boolean	isAddBeanTypes()	Add "_type" properties when needed.
protected final boolean	isAddKeyValueTableHeaders()	Add key/value headers on bean/map tables.
protected final boolean	isDetectLabelParameters()	Look for link labels in URIs.
protected final boolean	isDetectLinksInStrings()	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 keyName, String elementName, Namespace elementNamespace, boolean addNamespaceUris, XmlFormat format, boolean isMixed, boolean preserveWhitespace, BeanPropertyMeta pMeta)	Workhorse method.
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.

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

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

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

create, createPipe, getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, serialize, serializeToString

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

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

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

_class, addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlSerializerSession

protected HtmlSerializerSession(HtmlSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlSerializerSession.Builder create(HtmlSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

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

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doSerialize(SerializerSession,SerializerPipe,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 keyName,
 String elementName,
 Namespace elementNamespace,
 boolean addNamespaceUris,
 XmlFormat format,
 boolean isMixed,
 boolean preserveWhitespace,
 BeanPropertyMeta pMeta)
                                                        throws 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.

keyName - The property name or map key name.

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:

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 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:

SerializeException - Generic serialization error occurred.

isAddBeanTypes

protected final boolean isAddBeanTypes()

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.Builder.addBeanTypesHtml()

isAddKeyValueTableHeaders

protected final boolean isAddKeyValueTableHeaders()

Add key/value headers on bean/map tables.

Returns:

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

See Also:

• HtmlSerializer.Builder.addKeyValueTableHeaders()

isDetectLabelParameters

protected final boolean isDetectLabelParameters()

Look for link labels in URIs.

Returns:

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

See Also:

• HtmlSerializer.Builder.disableDetectLabelParameters()

isDetectLinksInStrings

protected final boolean isDetectLinksInStrings()

Look for URLs in Strings.

Returns:

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

See Also:

• HtmlSerializer.Builder.disableDetectLinksInStrings()

getLabelParameter

protected final String getLabelParameter()

Link label parameter name.

Returns:

The parameter name to look for when resolving link labels.

See Also:

• HtmlSerializer.Builder.labelParameter(String)

getUriAnchorText

protected final AnchorText getUriAnchorText()

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.Builder.uriAnchorText(AnchorText)

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.