com.helger.commons.xml.serialize.write

Enum EXMLSerializeXMLDeclaration

java.lang.Object

java.lang.Enum<EXMLSerializeXMLDeclaration>

com.helger.commons.xml.serialize.write.EXMLSerializeXMLDeclaration

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EXMLSerializeXMLDeclaration>

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

Used for creating string representation of XML. Determines whether the XML declaration (<?xml version=... encoding=...?>) should be emitted or ignored.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMIT
IGNORE

Method Summary

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

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Enum Constant Detail

EMIT

public static final EXMLSerializeXMLDeclaration EMIT

IGNORE

public static final EXMLSerializeXMLDeclaration IGNORE

Method Detail

values

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

Returns:

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

valueOf

public static EXMLSerializeXMLDeclaration 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 EXMLSerializeXMLDeclaration getFromIDOrNull(@Nullable
                                                                     String sID)