Enum WritabilityMode
- java.lang.Object
-
- java.lang.Enum<WritabilityMode>
-
- com.unboundid.directory.sdk.ds.types.WritabilityMode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<WritabilityMode>
@ThreadSafety(level=COMPLETELY_THREADSAFE) 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
Enum Constants Enum Constant Description 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 replication will be allowed.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WritabilityMode
forName(java.lang.String modeName)
Retrieves theWritabilityMode
for the specified name.java.lang.String
toString()
Retrieves a string representation of thisWritabilityMode
.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.
-
-
-
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 replication 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 namejava.lang.NullPointerException
- if the argument is null
-
forName
public static WritabilityMode forName(java.lang.String modeName)
Retrieves theWritabilityMode
for the specified name.- Parameters:
modeName
- The name of theWritabilityMode
to retrieve.- Returns:
- The requested
WritabilityMode
, ornull
if the provided value is not the name of a valid mode.
-
toString
public java.lang.String toString()
Retrieves a string representation of thisWritabilityMode
.- Overrides:
toString
in classjava.lang.Enum<WritabilityMode>
- Returns:
- A string representation of this
WritabilityMode
.
-
-