Package com.deltaxml.dita.config

Enum Class XmlVersionDeclaration

java.lang.Object

java.lang.Enum<XmlVersionDeclaration>

com.deltaxml.dita.config.XmlVersionDeclaration

All Implemented Interfaces:

com.deltaxml.dita.DitaCompareDisplayable, Serializable, Comparable<XmlVersionDeclaration>, Constable

public enum XmlVersionDeclaration
extends Enum<XmlVersionDeclaration>
implements com.deltaxml.dita.DitaCompareDisplayable

Represents the values for the version in the XML declaration.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SYSTEM	Use the 'B' document's xml version (as provided by the parser).
XML_1_0	Ensure the xml version is set to '1.0'.
XML_1_1	Ensure the xml version is set to '1.1'.

Method Summary

Modifier and Type	Method	Description
String	getDisplayDescription()	Returns the user-friendly String description of the XmlVersionDeclaration.
String	getDisplayName()	Returns the user-friendly String name of the XmlVersionDeclaration.
String	toString()	Returns a String representation of XmlVersionDeclaration.
static XmlVersionDeclaration	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XmlVersionDeclaration[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

XML_1_0

public static final XmlVersionDeclaration XML_1_0

Ensure the xml version is set to '1.0'.

XML_1_1

public static final XmlVersionDeclaration XML_1_1

Ensure the xml version is set to '1.1'.

SYSTEM

public static final XmlVersionDeclaration SYSTEM

Use the 'B' document's xml version (as provided by the parser).

Method Details

values

public static XmlVersionDeclaration[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static XmlVersionDeclaration valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns the user-friendly String name of the XmlVersionDeclaration.

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the XmlVersionDeclaration object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the XmlVersionDeclaration.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the XmlVersionDeclaration object

toString

public String toString()

Returns a String representation of XmlVersionDeclaration.

Overrides:

toString in class Enum<XmlVersionDeclaration>

Returns:

a String representing the XmlVersionDeclaration object