Package org.forgerock.api.enums

Enum Class ReadPolicy

java.lang.Object

java.lang.Enum<ReadPolicy>

org.forgerock.api.enums.ReadPolicy

All Implemented Interfaces:

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

public enum ReadPolicy
extends Enum<ReadPolicy>

Enum that represents the Schema read policies.

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
CLIENT	Property is hidden from user-interface, but readable via client APIs.
SERVER	Property is available internally, but not exposed to client APIs.
USER	Property is readable via client APIs and visible in the user-interface.

Method Summary

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

USER

public static final ReadPolicy USER

Property is readable via client APIs and visible in the user-interface.

CLIENT

public static final ReadPolicy CLIENT

Property is hidden from user-interface, but readable via client APIs. This is the default value if ReadPolicy is not specified.

SERVER

public static final ReadPolicy SERVER

Property is available internally, but not exposed to client APIs. Applications must actively filter this value from client API responses.

Method Details

values

public static ReadPolicy[] 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 ReadPolicy 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