RelationOption (OpenDJ Public API Javadoc 7.4.3-20241015115352-209ff3c0000cb208c40a9a5f707924f0af03b332 Documentation)

java.lang.Object
- java.lang.Enum<RelationOption>
- - org.forgerock.opendj.config.RelationOption

All Implemented Interfaces:

Serializable, Comparable<RelationOption>
```
public enum RelationOption
extends Enum<RelationOption>
```
This enumeration contains various options that can be associated with relation definitions.

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static RelationOption`	`valueOf(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(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