org.forgerock.api.enums

Enum WritePolicy

java.lang.Object

java.lang.Enum<WritePolicy>

org.forgerock.api.enums.WritePolicy

All Implemented Interfaces:

Serializable, Comparable<WritePolicy>

public enum WritePolicy
extends Enum<WritePolicy>

Enum that represents the Schema write policies.

Enum Constant Summary

Enum Constants

Enum Constant and Description
WRITABLE The property can be set at any time.
WRITE_ON_CREATE The property MAY be set in the create request, but not thereafter.
WRITE_ONCE The property MAY be set only if the current value is NULL.

Method Summary

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

WRITE_ON_CREATE

public static final WritePolicy WRITE_ON_CREATE

The property MAY be set in the create request, but not thereafter.

WRITE_ONCE

public static final WritePolicy WRITE_ONCE

The property MAY be set only if the current value is NULL.

WRITABLE

public static final WritePolicy WRITABLE

The property can be set at any time. This is the default value if no value is specified

Method Detail

values

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

Returns:

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

valueOf

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