org.apache.juneau.html.annotation

Enum HtmlFormat

java.lang.Object

java.lang.Enum<HtmlFormat>

org.apache.juneau.html.annotation.HtmlFormat

All Implemented Interfaces:

Serializable, Comparable<HtmlFormat>

public enum HtmlFormat
extends Enum<HtmlFormat>

Possible values for the Html.format() annotation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML Object is serialized to HTML.
HTML_CDC Object is serialized to HTML, use comma-delimited format instead of list.
HTML_SDC Object is serialized to HTML, use space-delimited format instead of list.
PLAIN_TEXT Object is serialized to a String using the toString() method and written directly to output.
XML Object is serialized to XML.

Method Summary

Modifier and Type	Method and Description
static HtmlFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static HtmlFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLAIN_TEXT

public static final HtmlFormat PLAIN_TEXT

Object is serialized to a String using the toString() method and written directly to output.
Useful when you want to serialize custom HTML.

HTML

public static final HtmlFormat HTML

Object is serialized to HTML.
This is the default value for serialization.

HTML_CDC

public static final HtmlFormat HTML_CDC

Object is serialized to HTML, use comma-delimited format instead of list.

HTML_SDC

public static final HtmlFormat HTML_SDC

Object is serialized to HTML, use space-delimited format instead of list.

XML

public static final HtmlFormat XML

Object is serialized to XML.
Useful when creating beans that model HTML elements.

Method Detail

values

public static HtmlFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HtmlFormat c : HtmlFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HtmlFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null