com.deltaxml.docbook

Enum XmlVersionDeclaration

java.lang.Object

java.lang.Enum<XmlVersionDeclaration>

com.deltaxml.docbook.XmlVersionDeclaration

All Implemented Interfaces:

DocBookCompareDisplayable, java.io.Serializable, java.lang.Comparable<XmlVersionDeclaration>

public enum XmlVersionDeclaration
extends java.lang.Enum<XmlVersionDeclaration>
implements DocBookCompareDisplayable

Represents the values for the version in the XML declaration.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
java.lang.String	getDisplayDescription() Returns the user friendly String description of the XmlVersionDeclaration.
java.lang.String	getDisplayName() Returns the user friendly String name of the XmlVersionDeclaration.
static XmlVersionDeclaration	getXmlVersionDeclaration(java.lang.String value) Returns a XmlVersionDeclaration object from the supplied String value if appropriate.
static XmlVersionDeclaration	parseValue(java.lang.String value) Returns a XmlVersionDeclaration object from the supplied String value if appropriate.
java.lang.String	toString() Returns a String representation of XmlVersionDeclaration.
static XmlVersionDeclaration	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static XmlVersionDeclaration[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

public static XmlVersionDeclaration valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDisplayName

public java.lang.String getDisplayName()

Returns the user friendly String name of the XmlVersionDeclaration.

Specified by:

getDisplayName in interface DocBookCompareDisplayable

Returns:

a user friendly String representing the XmlVersionDeclaration object

getDisplayDescription

public java.lang.String getDisplayDescription()

Returns the user friendly String description of the XmlVersionDeclaration.

Specified by:

getDisplayDescription in interface DocBookCompareDisplayable

Returns:

a user friendly String description representing the XmlVersionDeclaration object

toString

public java.lang.String toString()

Returns a String representation of XmlVersionDeclaration.

Overrides:

toString in class java.lang.Enum<XmlVersionDeclaration>

Returns:

a String representing the XmlVersionDeclaration object

getXmlVersionDeclaration

public static XmlVersionDeclaration getXmlVersionDeclaration(java.lang.String value)

Returns a XmlVersionDeclaration object from the supplied String value if appropriate.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

value - a String representation of a XmlVersionDeclaration value

Returns:

the XmlVersionDeclaration instance corresponding to the parameter, or null if the value is invalid

parseValue

public static XmlVersionDeclaration parseValue(java.lang.String value)
                                        throws java.lang.IllegalArgumentException

Returns a XmlVersionDeclaration object from the supplied String value if appropriate.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

value - a String representation of a XmlVersionDeclaration value

Returns:

the XmlVersionDeclaration instance corresponding to the parameter.

Throws:

java.lang.IllegalArgumentException - Whenever the provided string does not represent one of this enum'e enumerated values.