fr.techad.edc.httpd.search

Enum DocumentationItemType

java.lang.Object

java.lang.Enum<DocumentationItemType>

fr.techad.edc.httpd.search.DocumentationItemType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentationItemType>

public enum DocumentationItemType
extends java.lang.Enum<DocumentationItemType>

Define the Documentation Item type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARTICLE Article documentation item type. it can't contain anything.
CHAPTER Chapter documentation type.
CONTEXTUAL Contextual documentation item type ie bricks.
DOCUMENT Document documentation item type.It can contain ARTICLE documentation type
UNKNOWN Unknown documentation item type

Method Summary

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

UNKNOWN

public static final DocumentationItemType UNKNOWN

Unknown documentation item type

CHAPTER

public static final DocumentationItemType CHAPTER

Chapter documentation type. This is a documentation item which can contain DOCUMENT and CONTEXTUEL documentation item.

CONTEXTUAL

public static final DocumentationItemType CONTEXTUAL

Contextual documentation item type ie bricks. It can contain ARTICLE documentation type

DOCUMENT

public static final DocumentationItemType DOCUMENT

Document documentation item type.It can contain ARTICLE documentation type

ARTICLE

public static final DocumentationItemType ARTICLE

Article documentation item type. it can't contain anything.

Method Detail

values

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

Returns:

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

valueOf

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