org.odftoolkit.odfdom.dom.type.text
Enum OdfIndexScopeType

java.lang.Object
  java.lang.Enum<OdfIndexScopeType>
      org.odftoolkit.odfdom.dom.type.text.OdfIndexScopeType

All Implemented Interfaces:

Serializable, Comparable<OdfIndexScopeType>

public enum OdfIndexScopeType
extends Enum<OdfIndexScopeType>

DOM implementation of OpenDocument attribute text:index-scope.

Enum Constant Summary

CHAPTER

DOCUMENT

Method Summary

static OdfIndexScopeType	enumValueOf(String stringValue) String to enum, turns a String into its corresponding enum constant
String	toString() gets the name of this enum.
static String	toString(OdfIndexScopeType enumeration) enum to String, gets the name of this enum constant as a string.
static OdfIndexScopeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static OdfIndexScopeType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHAPTER

public static final OdfIndexScopeType CHAPTER

DOCUMENT

public static final OdfIndexScopeType DOCUMENT

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

gets the name of this enum.

Overrides:

toString in class Enum<OdfIndexScopeType>

Returns:

return the name of OdfIndexScopeType

toString

public static String toString(OdfIndexScopeType enumeration)

enum to String, gets the name of this enum constant as a string.

Parameters:

enumeration - the constant of OdfIndexScopeType, see text:index-scope

Returns:

return the name of OdfIndexScopeType

enumValueOf

public static OdfIndexScopeType enumValueOf(String stringValue)

String to enum, turns a String into its corresponding enum constant

Parameters:

stringValue - the name of OdfIndexScopeType

Returns:

return the constant of OdfIndexScopeType, see text:index-scope