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:
java.io.Serializable
,java.lang.Comparable<IndexEntry.Type>
- Enclosing class:
- IndexEntry
public static enum IndexEntry.Type extends java.lang.Enum<IndexEntry.Type>
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isSection()
static IndexEntry.Type
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static IndexEntry.Type[] 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 (IndexEntry.Type c : IndexEntry.Type.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static IndexEntry.Type 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 namejava.lang.NullPointerException
- if the argument is null
-
isSection
public boolean isSection()
-
-