com.phloc.commons.xml

Enum EXMLCharMode

java.lang.Object

java.lang.Enum<EXMLCharMode>

com.phloc.commons.xml.EXMLCharMode

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EXMLCharMode>

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

Defines the different characters modes that are relevant to determine invalid characters as well characters to be masked.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTRIBUTE_NAME Attribute name
ATTRIBUTE_VALUE_DOUBLE_QUOTES Attribute value surrounded by double quotes
ATTRIBUTE_VALUE_SINGLE_QUOTES Attribute value surrounded by single quotes
CDATA CDATA content
ELEMENT_NAME Element name
TEXT Text content

Method Summary

Methods

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

ELEMENT_NAME

public static final EXMLCharMode ELEMENT_NAME

Element name

ATTRIBUTE_NAME

public static final EXMLCharMode ATTRIBUTE_NAME

Attribute name

ATTRIBUTE_VALUE_DOUBLE_QUOTES

public static final EXMLCharMode ATTRIBUTE_VALUE_DOUBLE_QUOTES

Attribute value surrounded by double quotes

ATTRIBUTE_VALUE_SINGLE_QUOTES

public static final EXMLCharMode ATTRIBUTE_VALUE_SINGLE_QUOTES

Attribute value surrounded by single quotes

TEXT

public static final EXMLCharMode TEXT

Text content

CDATA

public static final EXMLCharMode CDATA

CDATA content

Method Detail

values

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

Returns:

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

valueOf

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

getFromIDOrNull

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