Package org.forgerock.opendj.config
Enum AdministratorAction.Type
- java.lang.Object
-
- java.lang.Enum<AdministratorAction.Type>
-
- org.forgerock.opendj.config.AdministratorAction.Type
-
- All Implemented Interfaces:
Serializable
,Comparable<AdministratorAction.Type>
- Enclosing class:
- AdministratorAction
public static enum AdministratorAction.Type extends Enum<AdministratorAction.Type>
Specifies the type of administrator action which must be performed in order for pending changes to take effect.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description COMPONENT_RESTART
Used when modifications to a property require a component restart in order to take effect (usually by disabling and re-enabling the component).NONE
Used when modifications to a property take effect immediately, and no additional administrator action is required.OTHER
Used when modifications to a property require an additional administrative action in order to take effect.SERVER_RESTART
Used when modifications to a property require a server restart in order to take effect.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
toString()
static AdministratorAction.Type
valueOf(String name)
Returns the enum constant of this type with the specified name.static AdministratorAction.Type[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final AdministratorAction.Type NONE
Used when modifications to a property take effect immediately, and no additional administrator action is required. May have a description describing how changes to the modified property will take effect.
-
OTHER
public static final AdministratorAction.Type OTHER
Used when modifications to a property require an additional administrative action in order to take effect. This should be used when neither a server restart nor a component restart are applicable. Always has a description which describes the additional administrator action which is required when the property is modified.
-
COMPONENT_RESTART
public static final AdministratorAction.Type COMPONENT_RESTART
Used when modifications to a property require a component restart in order to take effect (usually by disabling and re-enabling the component). May have a description describing any additional administrator action that is required when the component is restarted.
-
SERVER_RESTART
public static final AdministratorAction.Type SERVER_RESTART
Used when modifications to a property require a server restart in order to take effect. May have a description describing any additional administrator action that is required when the component is restarted.
-
-
Method Detail
-
values
public static AdministratorAction.Type[] 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 (AdministratorAction.Type c : AdministratorAction.Type.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AdministratorAction.Type 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 nameNullPointerException
- if the argument is null
-
toString
public String toString()
- Overrides:
toString
in classEnum<AdministratorAction.Type>
-
-