org.opends.server.types
Enum ConditionResult

java.lang.Object
  extended by java.lang.Enum<ConditionResult>
      extended by org.opends.server.types.ConditionResult
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ConditionResult>

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

This enumeration defines a result that could be returned from a boolean operation that may evaluate to true or false, but may also be undefined (i.e., "maybe"). A result of undefined indicates that further investigation may be required.


Enum Constant Summary
FALSE
          Indicates that the result of the associated check returned "false".
TRUE
          Indicates that the result of the associated check returned "true".
UNDEFINED
          Indicates that the associated check did not yield a definitive result and that additional checking might be required.
 
Method Summary
static ConditionResult inverseOf(ConditionResult value)
          Returns the logical inverse of a ConditionResult value.
 java.lang.String toString()
          Retrieves the human-readable name for this condition result.
static ConditionResult valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ConditionResult[] 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

TRUE

public static final ConditionResult TRUE
Indicates that the result of the associated check returned "true".


FALSE

public static final ConditionResult FALSE
Indicates that the result of the associated check returned "false".


UNDEFINED

public static final ConditionResult UNDEFINED
Indicates that the associated check did not yield a definitive result and that additional checking might be required.

Method Detail

values

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

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

valueOf

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

inverseOf

public static ConditionResult inverseOf(ConditionResult value)
Returns the logical inverse of a ConditionResult value. The inverse of the UNDEFINED value is UNDEFINED.

Parameters:
value - The value to invert.
Returns:
The logical inverse of the supplied value.

toString

public java.lang.String toString()
Retrieves the human-readable name for this condition result.

Overrides:
toString in class java.lang.Enum<ConditionResult>
Returns:
The human-readable name for this condition result.