Package org.apache.maven.doxia.index

Enum IndexEntry.Type

java.lang.Object

java.lang.Enum<IndexEntry.Type>

org.apache.maven.doxia.index.IndexEntry.Type

All Implemented Interfaces:

Serializable, Comparable<IndexEntry.Type>

Enclosing class:

IndexEntry

public static enum IndexEntry.Type
extends Enum<IndexEntry.Type>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFINED_TERM
FIGURE
SECTION_1
SECTION_2
SECTION_3
SECTION_4
SECTION_5
SECTION_6
TABLE
UNKNOWN	Used for unknown types but also for the root entry

Method Summary

Modifier and Type	Method	Description
boolean	isSection()
static IndexEntry.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexEntry.Type[]	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 Details

UNKNOWN

public static final IndexEntry.Type UNKNOWN

Used for unknown types but also for the root entry

SECTION_1

public static final IndexEntry.Type SECTION_1

SECTION_2

public static final IndexEntry.Type SECTION_2

SECTION_3

public static final IndexEntry.Type SECTION_3

SECTION_4

public static final IndexEntry.Type SECTION_4

SECTION_5

public static final IndexEntry.Type SECTION_5

SECTION_6

public static final IndexEntry.Type SECTION_6

DEFINED_TERM

public static final IndexEntry.Type DEFINED_TERM

FIGURE

public static final IndexEntry.Type FIGURE

TABLE

public static final IndexEntry.Type TABLE

Method Details

values

public static IndexEntry.Type[] values()

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

Returns:

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

valueOf

public static IndexEntry.Type 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

isSection

public boolean isSection()