cz.muni.fi.mathml.mathml2text.converter.impl

Enum XmlStreamConstant

java.lang.Object

java.lang.Enum<XmlStreamConstant>

cz.muni.fi.mathml.mathml2text.converter.impl.XmlStreamConstant

All Implemented Interfaces:

Serializable, Comparable<XmlStreamConstant>

public enum XmlStreamConstant
extends Enum<XmlStreamConstant>

This class is a copy of XMLStreamConstants interface. Makes working with XML stream events more understandable and readable.

Author:

Maros Kucbel Sep 15, 2012, 10:21:50 PM

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTRIBUTE Indicates an event is an attribute
CDATA Indicates an event is a CDATA section
CHARACTERS Indicates an event is characters
COMMENT Indicates an event is a comment
DTD Indicates an event is a DTD
END_DOCUMENT Indicates an event is an end document
END_ELEMENT Indicates an event is an end element
ENTITY_DECLARATION Indicates a Entity Declaration
ENTITY_REFERENCE Indicates an event is an entity reference
NAMESPACE Indicates the event is a namespace declaration
NOTATION_DECLARATION Indicates a Notation
PROCESSING_INSTRUCTION Indicates an event is a processing instruction
SPACE The characters are white space (see [XML], 2.10 "White Space Handling").
START_DOCUMENT Indicates an event is a start document
START_ELEMENT Indicates an event is a start element

Method Summary

Methods

Modifier and Type	Method and Description
static XmlStreamConstant	forEventCode(int eventCode) Returns a constant representing given event code or null, if theres is no constant for event code.
int	getEventCode() Returns event code of this constant.
static XmlStreamConstant	valueOf(String name) Returns the enum constant of this type with the specified name.
static XmlStreamConstant[]	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

START_ELEMENT

public static final XmlStreamConstant START_ELEMENT

Indicates an event is a start element

See Also:

StartElement

END_ELEMENT

public static final XmlStreamConstant END_ELEMENT

Indicates an event is an end element

See Also:

EndElement

PROCESSING_INSTRUCTION

public static final XmlStreamConstant PROCESSING_INSTRUCTION

Indicates an event is a processing instruction

See Also:

ProcessingInstruction

CHARACTERS

public static final XmlStreamConstant CHARACTERS

Indicates an event is characters

See Also:

Characters

COMMENT

public static final XmlStreamConstant COMMENT

Indicates an event is a comment

See Also:

Comment

SPACE

public static final XmlStreamConstant SPACE

The characters are white space (see [XML], 2.10 "White Space Handling"). Events are only reported as SPACE if they are ignorable white space. Otherwise they are reported as CHARACTERS.

See Also:

Characters

START_DOCUMENT

public static final XmlStreamConstant START_DOCUMENT

Indicates an event is a start document

See Also:

StartDocument

END_DOCUMENT

public static final XmlStreamConstant END_DOCUMENT

Indicates an event is an end document

See Also:

EndDocument

ENTITY_REFERENCE

public static final XmlStreamConstant ENTITY_REFERENCE

Indicates an event is an entity reference

See Also:

EntityReference

ATTRIBUTE

public static final XmlStreamConstant ATTRIBUTE

Indicates an event is an attribute

See Also:

Attribute

DTD

public static final XmlStreamConstant DTD

Indicates an event is a DTD

See Also:

DTD

CDATA

public static final XmlStreamConstant CDATA

Indicates an event is a CDATA section

See Also:

Characters

NAMESPACE

public static final XmlStreamConstant NAMESPACE

Indicates the event is a namespace declaration

See Also:

Namespace

NOTATION_DECLARATION

public static final XmlStreamConstant NOTATION_DECLARATION

Indicates a Notation

See Also:

NotationDeclaration

ENTITY_DECLARATION

public static final XmlStreamConstant ENTITY_DECLARATION

Indicates a Entity Declaration

See Also:

NotationDeclaration

Method Detail

values

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

Returns:

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

valueOf

public static XmlStreamConstant 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

getEventCode

public int getEventCode()

Returns event code of this constant.

Returns:

Event code.

forEventCode

public static XmlStreamConstant forEventCode(int eventCode)

Returns a constant representing given event code or null, if theres is no constant for event code.

Parameters:

eventCode - Event code.

Returns:

Constant equivalent to given event code.