org.apache.juneau.html

Class HtmlSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.xml.XmlSerializer

org.apache.juneau.html.HtmlSerializer

Direct Known Subclasses:

HtmlSerializer.Sq, HtmlSerializer.SqReadable, HtmlStrippedDocSerializer

public class HtmlSerializer
extends XmlSerializer

Serializes POJO models to HTML.

Media types

Handles Accept types: text/html

Produces Content-Type types: text/html

Description

The conversion is as follows...

• Maps (e.g. HashMap, TreeMap) and beans are converted to HTML tables with 'key' and 'value' columns.
• Collections (e.g. HashSet, LinkedList) and Java arrays are converted to HTML ordered lists.
• Collections of Maps and beans are converted to HTML tables with keys as headers.
• Everything else is converted to text.

This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. However, custom serializers can be constructed to fine-tune behavior.

The HtmlLink annotation can be used on beans to add hyperlinks to the output.

Behavior-specific subclasses

The following direct subclasses are provided for convenience:

• HtmlSerializer.Sq - Default serializer, single quotes.
• HtmlSerializer.SqReadable - Default serializer, single quotes, whitespace added.

Example:

// Use one of the default serializers to serialize a POJO String html = HtmlSerializer.DEFAULT.serialize(someObject); // Create a custom serializer that doesn't use whitespace and newlines HtmlSerializer serializer = new HtmlSerializerBuider().ws().build(); // Same as above, except uses cloning HtmlSerializer serializer = HtmlSerializer.DEFAULT.builder().ws().build(); // Serialize POJOs to HTML // Produces: // <ul><li>1<li>2<li>3</ul> List l = new ObjectList(1, 2, 3); String html = HtmlSerializer.DEFAULT.serialize(l); // Produces: // <table> // <tr><th>firstName</th><th>lastName</th></tr> // <tr><td>Bob</td><td>Costas</td></tr> // <tr><td>Billy</td><td>TheKid</td></tr> // <tr><td>Barney</td><td>Miller</td></tr> // </table> l = new ObjectList(); l.add(new ObjectMap("{firstName:'Bob',lastName:'Costas'}")); l.add(new ObjectMap("{firstName:'Billy',lastName:'TheKid'}")); l.add(new ObjectMap("{firstName:'Barney',lastName:'Miller'}")); String html = HtmlSerializer.DEFAULT.serialize(l); // Produces: // <table> // <tr><th>key</th><th>value</th></tr> // <tr><td>foo</td><td>bar</td></tr> // <tr><td>baz</td><td>123</td></tr> // </table> Map m = new ObjectMap("{foo:'bar',baz:123}"); String html = HtmlSerializer.DEFAULT.serialize(m); // HTML elements can be nested arbitrarily deep // Produces: // <table> // <tr><th>key</th><th>value</th></tr> // <tr><td>foo</td><td>bar</td></tr> // <tr><td>baz</td><td>123</td></tr> // <tr><td>someNumbers</td><td><ul><li>1<li>2<li>3</ul></td></tr> // <tr><td>someSubMap</td><td> // <table> // <tr><th>key</th><th>value</th></tr> // <tr><td>a</td><td>b</td></tr> // </table> // </td></tr> // </table> Map m = new ObjectMap("{foo:'bar',baz:123}"); m.put("someNumbers", new ObjectList(1, 2, 3)); m.put("someSubMap", new ObjectMap("{a:'b'}")); String html = HtmlSerializer.DEFAULT.serialize(m);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HtmlSerializer.Sq Default serializer, single quotes.
static class	HtmlSerializer.SqReadable Default serializer, single quotes, whitespace added.

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

XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable

Field Summary

Fields

Modifier and Type	Field and Description
static HtmlSerializer	DEFAULT Default serializer, all default settings.
static HtmlSerializer	DEFAULT_SQ Default serializer, single quotes.
static HtmlSerializer	DEFAULT_SQ_READABLE Default serializer, single quotes, whitespace added.
static String	HTML_addBeanTypeProperties Configuration property: Add "_type" properties when needed.
static String	HTML_addKeyValueTableHeaders Configuration property: Add key/value headers on bean/map tables.
static String	HTML_detectLabelParameters Configuration property: Look for link labels in URIs.
static String	HTML_detectLinksInStrings Configuration property: Look for URLs in Strings.
static String	HTML_labelParameter Configuration property: Link label parameter name.
static String	HTML_uriAnchorText Configuration property: Anchor text source.

Fields inherited from class org.apache.juneau.xml.XmlSerializer

DEFAULT_NS, DEFAULT_NS_SQ, DEFAULT_NS_SQ_READABLE, XML_addBeanTypeProperties, XML_addNamespaceUrisToRoot, XML_autoDetectNamespaces, XML_defaultNamespace, XML_enableNamespaces, XML_namespaces, XML_xsNamespace

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

SERIALIZER_abridged, SERIALIZER_addBeanTypeProperties, SERIALIZER_detectRecursions, SERIALIZER_ignoreRecursions, SERIALIZER_initialDepth, SERIALIZER_listener, SERIALIZER_maxDepth, SERIALIZER_maxIndent, SERIALIZER_quoteChar, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution, SERIALIZER_useWhitespace

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_debug, BEAN_excludeProperties, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
HtmlSerializer(PropertyStore ps) Constructor.
HtmlSerializer(PropertyStore ps, String produces, String... accept) Constructor.

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.
HtmlSerializerBuilder	builder() Creates a builder from this context object.
static HtmlSerializerBuilder	create() Instantiates a new clean-slate HtmlSerializerBuilder object.
WriterSerializerSession	createSession(SerializerSessionArgs args) Create the session object used for actual serialization of objects.
HtmlSerializer	getSchemaSerializer() Returns the schema serializer based on the settings of this serializer.

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

isWriterSerializer, println, serialize, toString, toStringObject

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

createDefaultSessionArgs, createSession, getMediaTypes, getResponseContentType, serialize

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getExcludeProperties, getImplClassConstructor, getIncludeProperties, hasSameCache, isBean, isNotABean, newInstance, newInstance, newInstanceFromOuter, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HTML_addBeanTypeProperties

public static final String HTML_addBeanTypeProperties

Configuration property: Add "_type" properties when needed.

Property:

• Name: "HtmlSerializer.addBeanTypeProperties.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • HtmlSerializerBuilder.addBeanTypeProperties(boolean)

Description:

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

When present, this value overrides the Serializer.SERIALIZER_addBeanTypeProperties setting and is provided to customize the behavior of specific serializers in a SerializerGroup.

See Also:

Constant Field Values

HTML_addKeyValueTableHeaders

public static final String HTML_addKeyValueTableHeaders

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

Property:

• Name: "HtmlSerializer.addKeyValueTableHeaders.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Annotations:
  • Html.noTableHeaders()
• Methods:
  • HtmlSerializerBuilder.addKeyValueTableHeaders(boolean)
  • HtmlSerializerBuilder.addKeyValueTableHeaders()

When enabled, key and value column headers are added to tables.

Example:

// Our bean class. public class MyBean { public String f1 = "foo"; public String f2 = "bar"; } // Serializer without headers. WriterSerializer s1 = HtmlSerializer.DEFAULT; // Serializer with headers. WriterSerializer s2 = HtmlSerializer .create() .addKeyValueTableHeaders() .build(); String withoutHeaders = s1.serialize(new MyBean()); String withHeaders = s2.serialize(new MyBean());

The following shows the difference between the two generated outputs:

withoutHeaders	withHeaders
f1 foo f2 bar	key value f1 foo f2 bar

See Also:

Constant Field Values

HTML_detectLinksInStrings

public static final String HTML_detectLinksInStrings

Configuration property: Look for URLs in Strings.

Property:

• Name: "HtmlSerializer.detectLinksInStrings.b"
• Data type: Boolean
• Default: true
• Session-overridable: true
• Methods:
  • HtmlSerializerBuilder.detectLinksInStrings(boolean)

Description:

If a string looks like a URL (i.e. starts with "http://" or "https://", then treat it like a URL and make it into a hyperlink based on the rules specified by HTML_uriAnchorText.

Example:

// Our bean class with a property containing what looks like a URL. public class MyBean { public String f1 = "http://www.apache.org"; } // Serializer with link detection. WriterSerializer s1 = HtmlSerializer .create() .addKeyValueTableHeaders() .build(); // Serializer without link detection. WriterSerializer s2 = HtmlSerializer .create() .addKeyValueTableHeaders() .detectLinksInStrings(false) .build(); String withLinks = s1.serialize(new MyBean()); String withoutLinks = s2.serialize(new MyBean());

The following shows the difference between the two generated outputs:

withLinks	withoutLinks
key value f1 http://www.apache.org	key value f1 http://www.apache.org

See Also:

Constant Field Values

HTML_labelParameter

public static final String HTML_labelParameter

Configuration property: Link label parameter name.

Property:

• Name: "HtmlSerializer.labelParameter.s"
• Data type: String
• Default: "label"
• Session-overridable: true
• Methods:
  • HtmlSerializerBuilder.labelParameter(String)

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

See Also:

• HTML_detectLabelParameters

See Also:

Constant Field Values

HTML_detectLabelParameters

public static final String HTML_detectLabelParameters

Configuration property: Look for link labels in URIs.

Property:

• Name: "HtmlSerializer.detectLabelParameters.b"
• Data type: Boolean
• Default: true
• Session-overridable: true
• Methods:
  • HtmlSerializerBuilder.detectLabelParameters(boolean)

Description:

If the URL has a label parameter (e.g. "?label=foobar"), then use that as the anchor text of the link.

The parameter name can be changed via the HTML_labelParameter property.

Example:

// Our bean class with a property containing what looks like a URL. public class MyBean { public URI f1 = URI.create("http://www.apache.org?label=Apache%20Foundation"); } // Serializer with label detection. WriterSerializer s1 = HtmlSerializer .create() .addKeyValueTableHeaders() .build(); // Serializer without label detection. WriterSerializer s2 = HtmlSerializer .create() .addKeyValueTableHeaders() .lookForLabelParameters(false) .build(); String withLabels = s1.serialize(new MyBean()); String withoutLabels = s2.serialize(new MyBean());

The following shows the difference between the two generated outputs.
Note that they're both hyperlinks, but the anchor text differs:

withLabels	withoutLabels
key value f1 Apache Foundation	key value f1 http://www.apache.org?label=Apache%20Foundation

See Also:

Constant Field Values

HTML_uriAnchorText

public static final String HTML_uriAnchorText

Configuration property: Anchor text source.

Property:

• Name: "HtmlSerializer.uriAnchorText.s"
• Data type: String (AnchorText)
• Default: "TO_STRING"
• Session-overridable: true
• Annotations:
  • Html.anchorText()
• Methods:
  • HtmlSerializerBuilder.uriAnchorText(AnchorText)
  • HtmlSerializerBuilder.uriAnchorText(String)

Description:

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

The possible values are:

• AnchorText
  • TO_STRING (default) - Set to whatever is returned by Context.toString() on the object.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("http://www.apache.org?foo=bar#myAnchor"); } // Serializer with TO_STRING anchor text. WriterSerializer s1 = HtmlSerializer.create().anchorText(TO_STRING).build(); // Produces: <a href='http://www.apache.org?foo=bar#myAnchor'>http://www.apache.org?foo=bar#myAnchor</a> String html = s1.serialize(new MyBean());

  • PROPERTY_NAME - Set to the bean property name.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("http://www.apache.org?foo=bar#myAnchor"); } // Serializer with PROPERTY_NAME anchor text. WriterSerializer s1 = HtmlSerializer.create().anchorText(PROPERTY_NAME).build(); // Produces: <a href='http://www.apache.org?foo=bar#myAnchor'>f1</a> String html = s1.serialize(new MyBean());

  • URI - Set to the URI value.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("http://www.apache.org?foo=bar#myAnchor"); } // Serializer with URI anchor text. WriterSerializer s1 = HtmlSerializer.create().anchorText(URI).build(); // Produces: <a href='http://www.apache.org?foo=bar#myAnchor'>http://www.apache.org?foo=bar</a> String html = s1.serialize(new MyBean());

  • LAST_TOKEN - Set to the last token of the URI value.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("http://www.apache.org/foo/bar?baz=qux#myAnchor"); } // Serializer with LAST_TOKEN anchor text. WriterSerializer s1 = HtmlSerializer.create().anchorText(LAST_TOKEN).build(); // Produces: <a href='http://www.apache.org/foo/bar?baz=qux#myAnchor'>bar</a> String html = s1.serialize(new MyBean());

  • URI_ANCHOR - Set to the anchor of the URL.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("http://www.apache.org/foo/bar?baz=qux#myAnchor"); } // Serializer with URI_ANCHOR anchor text. WriterSerializer s1 = HtmlSerializer.create().anchorText(URI_ANCHOR).build(); // Produces: <a href='http://www.apache.org/foo/bar?baz=qux#myAnchor'>myAnchor</a> String html = s1.serialize(new MyBean());

  • CONTEXT_RELATIVE - Same as TO_STRING but assumes it's a context-relative path.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("bar/baz"); } // Serializer with CONTEXT_RELATIVE anchor text. WriterSerializer s1 = HtmlSerializer .create() .anchorText(CONTEXT_RELATIVE) .uriResolution(ROOT_RELATIVE) .uriRelativity(RESOURCE) .uriContext("{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}") .build(); // Produces: <a href='/myContext/myServlet/bar/baz'>myServlet/bar/baz</a> String html = s1.serialize(new MyBean());

  • SERVLET_RELATIVE - Same as TO_STRING but assumes it's a servlet-relative path.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("bar/baz"); } // Serializer with SERVLET_RELATIVE anchor text. WriterSerializer s1 = HtmlSerializer .create() .anchorText(SERVLET_RELATIVE) .uriResolution(ROOT_RELATIVE) .uriRelativity(RESOURCE) .uriContext("{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}") .build(); // Produces: <a href='/myContext/myServlet/bar/baz'>bar/baz</a> String html = s1.serialize(new MyBean());

  • PATH_RELATIVE - Same as TO_STRING but assumes it's a path-relative path.
    

    Example:

    // Our bean class with a URI property. public class MyBean { public URI f1 = URI.create("bar/baz"); } // Serializer with PATH_RELATIVE anchor text. WriterSerializer s1 = HtmlSerializer .create() .anchorText(PATH_RELATIVE) .uriResolution(ROOT_RELATIVE) .uriRelativity(PATH_INFO) .uriContext("{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}") .build(); // Produces: <a href='/myContext/myServlet/foo/bar/baz'>bar/baz</a> String html = s1.serialize(new MyBean());

See Also:

Constant Field Values

DEFAULT

public static final HtmlSerializer DEFAULT

Default serializer, all default settings.

DEFAULT_SQ

public static final HtmlSerializer DEFAULT_SQ

Default serializer, single quotes.

DEFAULT_SQ_READABLE

public static final HtmlSerializer DEFAULT_SQ_READABLE

Default serializer, single quotes, whitespace added.

Constructor Detail

HtmlSerializer

public HtmlSerializer(PropertyStore ps)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

HtmlSerializer

public HtmlSerializer(PropertyStore ps,
                      String produces,
                      String... accept)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

produces - The media type that this serializer produces.

accept - The accept media types that the serializer can handle.

Can contain meta-characters per the media-type specification of RFC2616/14.1

If empty, then assumes the only media type supported is produces.

For example, if this serializer produces "application/json" but should handle media types of "application/json" and "text/json", then the arguments should be:

super(ps, "application/json", "application/json", "text/json");

...or...

super(ps, "application/json", "*/json");

Method Detail

builder

public HtmlSerializerBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class XmlSerializer

Returns:

A new ContextBuilder object.

create

public static HtmlSerializerBuilder create()

Instantiates a new clean-slate HtmlSerializerBuilder object.

This is equivalent to simply calling new HtmlSerializerBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new HtmlSerializerBuilder object.

getSchemaSerializer

public HtmlSerializer getSchemaSerializer()

Description copied from class: XmlSerializer

Returns the schema serializer based on the settings of this serializer.

Overrides:

getSchemaSerializer in class XmlSerializer

Returns:

The schema serializer.

createSession

public WriterSerializerSession createSession(SerializerSessionArgs args)

Description copied from class: Serializer

Create the session object used for actual serialization of objects.

Overrides:

createSession in class XmlSerializer

Parameters:

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.

Returns:

The new session object.

asMap

public ObjectMap asMap()

Description copied from class: Context

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

Overrides:

asMap in class XmlSerializer

Returns:

A new map containing the properties defined on this context.