org.opends.server.admin
Enum RelationOption

java.lang.Object
  java.lang.Enum<RelationOption>
      org.opends.server.admin.RelationOption

All Implemented Interfaces:

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

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

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

Enum Constant Summary

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

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

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 Detail

values

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

Returns:

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

valueOf

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