Package org.apache.juneau.marshall.html

Class HtmlSerializerSession.Builder<SELF extends HtmlSerializerSession.Builder<SELF>>

java.lang.Object

org.apache.juneau.marshall.ContextSession.Builder<SELF>

org.apache.juneau.marshall.MarshallingSession.Builder<SELF>

org.apache.juneau.marshall.MarshallingTraverseSession.Builder<SELF>

org.apache.juneau.marshall.serializer.SerializerSession.Builder<SELF>

org.apache.juneau.marshall.serializer.WriterSerializerSession.Builder<SELF>

org.apache.juneau.marshall.xml.XmlSerializerSession.Builder<SELF>

org.apache.juneau.marshall.html.HtmlSerializerSession.Builder<SELF>

Direct Known Subclasses:

HtmlSchemaSerializerSession.Builder, HtmlSerializerSession.DefaultBuilder, HtmlStrippedDocSerializerSession.Builder

Enclosing class:

HtmlSerializerSession

public abstract static class HtmlSerializerSession.Builder<SELF extends HtmlSerializerSession.Builder<SELF>>
extends XmlSerializerSession.Builder<SELF>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(HtmlSerializer ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
SELF	addKeyValueTableHeaders(boolean value)	Add key/value headers on bean/map tables.
HtmlSerializerSession	build()	Build the object.
SELF	detectLabelParameters(boolean value)	Look for link labels in URIs.
SELF	detectLinksInStrings(boolean value)	Look for URLs in Strings.
SELF	labelParameter(String value)	The label parameter name.
SELF	property(String key, Object value)	Adds a property to this session.
SELF	uriAnchorText(AnchorText value)	The anchor text to use for URL objects.

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

addNamespaceUrisToRoot, autoDetectNamespaces, defaultNamespace, enableNamespaces, textNodeDelimiter

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

maxIndent, quoteChar, streamCharset, useWhitespace

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

addBeanTypes, addRootType, javaMethod, keepNullProperties, nonDefault, resolver, schema, schemaDefault, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings, uriContext

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession.Builder

initialDepth

Methods inherited from class org.apache.juneau.marshall.MarshallingSession.Builder

activeView, locale, mediaType, mediaTypeDefault, timeZone, timeZoneDefault

Methods inherited from class org.apache.juneau.marshall.ContextSession.Builder

apply, cvt, debug, properties, self, unmodifiable

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(HtmlSerializer ctx)

Constructor

Parameters:

ctx - The context creating this session.
Cannot be null.

Method Details

build

public HtmlSerializerSession build()

Description copied from class: MarshallingSession.Builder

Build the object.

Overrides:

build in class XmlSerializerSession.Builder<SELF extends HtmlSerializerSession.Builder<SELF>>

Returns:

The built object.

addKeyValueTableHeaders

public SELF addKeyValueTableHeaders(boolean value)

Add key/value headers on bean/map tables.

Parameters:

value - The new value for this setting.

Returns:

This object.

detectLabelParameters

public SELF detectLabelParameters(boolean value)

Look for link labels in URIs.

Parameters:

value - The new value for this setting.

Returns:

This object.

detectLinksInStrings

public SELF detectLinksInStrings(boolean value)

Look for URLs in Strings.

Parameters:

value - The new value for this setting.

Returns:

This object.

labelParameter

public SELF labelParameter(String value)

The label parameter name.

Parameters:

value - The new value for this setting.

Returns:

This object.

uriAnchorText

public SELF uriAnchorText(AnchorText value)

The anchor text to use for URL objects.

Parameters:

value - The new value for this setting.

Returns:

This object.

property

public SELF property(String key,
 Object value)

Description copied from class: ContextSession.Builder

Adds a property to this session.

If the key matches a known session property (e.g. "debug" or "ContextSession.debug"), the value is converted via BasicConverter and routed to the corresponding typed setter. Unknown keys are stored in the raw session properties map.

Overrides:

property in class XmlSerializerSession.Builder<SELF extends HtmlSerializerSession.Builder<SELF>>

Parameters:

key - The property key.
Cannot be null.

value - The property value.
Can be null (resets typed properties to their default; removes raw properties).

Returns:

This object.