com.helger.commons.xml.serialize.write

Enum EXMLSerializeIndent

java.lang.Object

java.lang.Enum<EXMLSerializeIndent>

com.helger.commons.xml.serialize.write.EXMLSerializeIndent

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<EXMLSerializeIndent>

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

Determines the indentation and alignment mode of XML serialization. Alignment means: newlines after certain elements. Indent means: adding blanks at the beginning of the line to reflect the tree structure of an XML document more visibly.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIGN_ONLY No indent but align
INDENT_AND_ALIGN Both indent and align.
INDENT_ONLY Indent but no align.
NONE Neither indent nor align

Method Summary

Methods

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

NONE

public static final EXMLSerializeIndent NONE

Neither indent nor align

ALIGN_ONLY

public static final EXMLSerializeIndent ALIGN_ONLY

No indent but align

INDENT_ONLY

public static final EXMLSerializeIndent INDENT_ONLY

Indent but no align.

INDENT_AND_ALIGN

public static final EXMLSerializeIndent INDENT_AND_ALIGN

Both indent and align.

Method Detail

values

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

Returns:

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

valueOf

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

isIndent

public boolean isIndent()

Returns:

true if the XML output should be formatted nicely

isAlign

public boolean isAlign()

Returns:

true if newlines should be emitted

getWithoutIndent

@Nonnull
public EXMLSerializeIndent getWithoutIndent()

getWithIndent

@Nonnull
public EXMLSerializeIndent getWithIndent()

getWithoutAlign

@Nonnull
public EXMLSerializeIndent getWithoutAlign()

getWithAlign

@Nonnull
public EXMLSerializeIndent getWithAlign()

getFromIDOrNull

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