Package org.forgerock.opendj.rest2ldap

Enum WritabilityPolicy

java.lang.Object

java.lang.Enum<WritabilityPolicy>

org.forgerock.opendj.rest2ldap.WritabilityPolicy

All Implemented Interfaces:

Serializable, Comparable<WritabilityPolicy>

public enum WritabilityPolicy
extends Enum<WritabilityPolicy>

The writability policy determines whether an attribute supports updates.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_ONLY	The attribute may be provided when creating a new resource, but cannot be modified afterwards.
CREATE_ONLY_DISCARD_WRITES	The attribute may be provided when creating a new resource, but cannot be modified afterwards.
READ_ONLY	The attribute cannot be provided when creating a new resource, nor modified afterwards.
READ_ONLY_DISCARD_WRITES	The attribute cannot be provided when creating a new resource, nor modified afterwards.
READ_WRITE	The attribute may be provided when creating a new resource, and modified afterwards.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READ_ONLY

public static final WritabilityPolicy READ_ONLY

The attribute cannot be provided when creating a new resource, nor modified afterwards. Attempts to update the attribute will result in an error.

READ_ONLY_DISCARD_WRITES

public static final WritabilityPolicy READ_ONLY_DISCARD_WRITES

The attribute cannot be provided when creating a new resource, nor modified afterwards. Attempts to update the attribute will not result in an error (the new values will be ignored).

CREATE_ONLY

public static final WritabilityPolicy CREATE_ONLY

The attribute may be provided when creating a new resource, but cannot be modified afterwards. Attempts to update the attribute will result in an error.

CREATE_ONLY_DISCARD_WRITES

public static final WritabilityPolicy CREATE_ONLY_DISCARD_WRITES

The attribute may be provided when creating a new resource, but cannot be modified afterwards. Attempts to update the attribute will not result in an error (the new values will be ignored).

READ_WRITE

public static final WritabilityPolicy READ_WRITE

The attribute may be provided when creating a new resource, and modified afterwards.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<WritabilityPolicy>