org.opends.server.types
Enum WritabilityMode

java.lang.Object
  java.lang.Enum<WritabilityMode>
      org.opends.server.types.WritabilityMode

All Implemented Interfaces:

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

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum WritabilityMode
extends java.lang.Enum<WritabilityMode>

This class implements an enumeration that may be used to control the writability mode for the entire server or for a specific backend. The writability mode may be "enabled", "disabled", or "internal-only".

Enum Constant Summary

DISABLED
Indicates that all write operations should be rejected.

ENABLED
Indicates that all write operations should be allowed.

INTERNAL_ONLY
Indicates that write operations from clients will be rejected, but internal operations and updates through synchronization will be allowed.

Method Summary

static WritabilityMode	modeForName(java.lang.String modeName) Retrieves the writability mode for the specified name.
java.lang.String	toString() Retrieves a string representation of this writability mode.
static WritabilityMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WritabilityMode[]	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

ENABLED

public static final WritabilityMode ENABLED

Indicates that all write operations should be allowed.

DISABLED

public static final WritabilityMode DISABLED

Indicates that all write operations should be rejected.

INTERNAL_ONLY

public static final WritabilityMode INTERNAL_ONLY

Indicates that write operations from clients will be rejected, but internal operations and updates through synchronization will be allowed.

Method Detail

values

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

Returns:

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

valueOf

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

modeForName

public static WritabilityMode modeForName(java.lang.String modeName)

Retrieves the writability mode for the specified name.

Parameters:

modeName - The name of the writability mode to retrieve.

Returns:

The requested writability mode, or null if the provided value is not the name of a valid mode.

toString

public java.lang.String toString()

Retrieves a string representation of this writability mode.

Overrides:

toString in class java.lang.Enum<WritabilityMode>

Returns:

A string representation of this writability mode.