org.opencms.search.documents

Enum CmsDocumentDependency.DependencyType

java.lang.Object

java.lang.Enum<CmsDocumentDependency.DependencyType>

org.opencms.search.documents.CmsDocumentDependency.DependencyType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsDocumentDependency.DependencyType>

Enclosing class:

CmsDocumentDependency

public static enum CmsDocumentDependency.DependencyType
extends java.lang.Enum<CmsDocumentDependency.DependencyType>

Defines the possible dependency types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
attachment A attachment dependency.
document The main document dependency.
variant A variant dependency.

Method Summary

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

attachment

public static final CmsDocumentDependency.DependencyType attachment

A attachment dependency.

document

public static final CmsDocumentDependency.DependencyType document

The main document dependency.

variant

public static final CmsDocumentDependency.DependencyType variant

A variant dependency.

Method Detail

values

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

Returns:

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

valueOf

public static CmsDocumentDependency.DependencyType 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