com.phloc.commons.xml.serialize

Enum EXMLSerializeComments

java.lang.Object

java.lang.Enum<EXMLSerializeComments>

com.phloc.commons.xml.serialize.EXMLSerializeComments

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EXMLSerializeComments>

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

Determines whether comments should be serialized or not.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMIT
IGNORE

Method Summary

Methods

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

EMIT

public static final EXMLSerializeComments EMIT

IGNORE

public static final EXMLSerializeComments IGNORE

Method Detail

values

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

Returns:

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

valueOf

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

isEmit

public boolean isEmit()

Returns:

true it emit is enabled

getFromIDOrNull

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