com.phloc.commons.xml.serialize

Enum EXMLSerializeVersion

java.lang.Object

java.lang.Enum<EXMLSerializeVersion>

com.phloc.commons.xml.serialize.EXMLSerializeVersion

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EXMLSerializeVersion>

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

XML serialization version.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML HTML
XHTML XHTML
XML_10 XML 1.0
XML_11 XML 1.1

Method Summary

Methods

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

XML_10

public static final EXMLSerializeVersion XML_10

XML 1.0

XML_11

public static final EXMLSerializeVersion XML_11

XML 1.1

HTML

public static final EXMLSerializeVersion HTML

HTML

XHTML

public static final EXMLSerializeVersion XHTML

XHTML

Method Detail

values

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

Returns:

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

valueOf

public static EXMLSerializeVersion 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.

isXML

public boolean isXML()

Returns:

true if this is an XML version (1.0 or 1.1)

isHTML

public boolean isHTML()

Returns:

true if this is HTML (HTML or XHTML)

requiresXMLDeclaration

public boolean requiresXMLDeclaration()

Returns:

true for all except HTML

getXMLVersionString

@Nullable
public String getXMLVersionString()

Returns:

null if no XML version is required, the respective version string otherwise.

See Also:

requiresXMLDeclaration()

getFromXMLVersionOrThrow

@Nonnull
public static EXMLSerializeVersion getFromXMLVersionOrThrow(@Nonnull
                                                    EXMLVersion eXMLVersion)

Get the EXMLSerializeVersion from the specified EXMLVersion .

Parameters:

eXMLVersion - XML version to query. May not be null.

Returns:

Never null.

getFromIDOrNull

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