com.phloc.commons.xml.serialize

Enum EXMLSerializeFormat

java.lang.Object

java.lang.Enum<EXMLSerializeFormat>

com.phloc.commons.xml.serialize.EXMLSerializeFormat

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EXMLSerializeFormat>

public enum EXMLSerializeFormat
extends Enum<EXMLSerializeFormat>
implements IHasID<String>

Determines the output format for XML serialization. XML or HTML?

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML
XHTML
XML

Method Summary

Methods

Modifier and Type	Method and Description
static EXMLSerializeFormat	getFromIDOrNull(String sID)
String	getID() Get the unique ID of this object.
boolean	isHTML()
boolean	isXHTML()
boolean	isXML()
static EXMLSerializeFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static EXMLSerializeFormat[]	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

HTML

public static final EXMLSerializeFormat HTML

XHTML

public static final EXMLSerializeFormat XHTML

XML

public static final EXMLSerializeFormat XML

Method Detail

values

public static EXMLSerializeFormat[] 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 (EXMLSerializeFormat c : EXMLSerializeFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static EXMLSerializeFormat 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

getID

@Nonnull
@Nonempty
public String getID()

Description copied from interface: IHasID

Get the unique ID of this object. If the type is String than the returned value must match an XML NMToken expression (so e.g. no ':' in the ID)!

Specified by:

getID in interface IHasID<String>

Returns:

The ID of this object. May not be null.

isHTML

public boolean isHTML()

Returns:

true if the serialization format is HTML

isXHTML

public boolean isXHTML()

Returns:

true if the serialization format is XHTML

isXML

public boolean isXML()

Returns:

true if the serialization format is XML

getFromIDOrNull

@Nullable
public static EXMLSerializeFormat getFromIDOrNull(@Nullable
                                           String sID)