Package org.forgerock.opendj.config

Enum Class RelationOption

java.lang.Object

java.lang.Enum<RelationOption>

org.forgerock.opendj.config.RelationOption

All Implemented Interfaces:

Serializable, Comparable<RelationOption>, java.lang.constant.Constable

public enum RelationOption
extends Enum<RelationOption>

This enumeration contains various options that can be associated with relation definitions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADVANCED	Use this option to identify relations which should be considered as advanced and should not be exposed by default in client applications.
HIDDEN	Use this option to identify relations which must not be directly exposed in client applications.

Method Summary

Modifier and Type	Method	Description
static RelationOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RelationOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADVANCED

public static final RelationOption ADVANCED

Use this option to identify relations which should be considered as advanced and should not be exposed by default in client applications.

HIDDEN

public static final RelationOption HIDDEN

Use this option to identify relations which must not be directly exposed in client applications.

Method Details

values

public static RelationOption[] values()

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

Returns:

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

valueOf

public static RelationOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null