Package org.nuxeo.ecm.core.io.registry.context

Enum DepthValues

java.lang.Object

java.lang.Enum<DepthValues>

org.nuxeo.ecm.core.io.registry.context.DepthValues

All Implemented Interfaces:

Serializable, Comparable<DepthValues>

public enum DepthValues
extends Enum<DepthValues>

Possible depth values for "marshaller-to-marshaller" calls (to avoid the infinite loops).

Since:

7.2

Enum Constant Summary

Enum Constants

Enum Constant	Description
children	Loads / Fetches / Enriches the first level element(s) and its (their) children.
max	Loads / Fetches / Enriches the first level element(s), its (their) children, and the grandchildren.
root	Loads / Fetches / Enriches the first level element(s).

Method Summary

Modifier and Type	Method	Description
int	getDepth()	Gets the corresponding depth value.
static DepthValues	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DepthValues[]	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

root

public static final DepthValues root

Loads / Fetches / Enriches the first level element(s).

children

public static final DepthValues children

Loads / Fetches / Enriches the first level element(s) and its (their) children.

max

public static final DepthValues max

Loads / Fetches / Enriches the first level element(s), its (their) children, and the grandchildren.

Method Detail

values

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

Returns:

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

valueOf

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

getDepth

public int getDepth()

Gets the corresponding depth value.

Returns:

The depth.

Since:

7.2