com.unboundid.directory.sdk.common.types
Enum ConditionResult

java.lang.Object
  java.lang.Enum<ConditionResult>
      com.unboundid.directory.sdk.common.types.ConditionResult

All Implemented Interfaces:

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

public enum ConditionResult
extends java.lang.Enum<ConditionResult>

This enum defines a set of values which may be used to represent the result of a Boolean evaluation in which the result may be undefined.

Enum Constant Summary

FALSE
A condition result value which represents a Boolean result of "false".

TRUE
A condition result value which represents a Boolean result of "true".

UNDEFINED
A condition result value which represents an undefined result.

Method Summary

ConditionResult	invert() Retrieves the condition result value which is the inverse of this value.
static ConditionResult	invert(ConditionResult r) Retrieves the condition result value which is the inverse of the provided result.
java.lang.String	toString() Retrieves a string representation of this condition result value.
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

A condition result value which represents a Boolean result of "true".

FALSE

public static final ConditionResult FALSE

A condition result value which represents a Boolean result of "false".

UNDEFINED

public static final ConditionResult UNDEFINED

A condition result value which represents an undefined result.

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

invert

public ConditionResult invert()

Retrieves the condition result value which is the inverse of this value. The inverse of TRUE is FALSE, and vice-versa. The inverse of UNDEFINED is UNDEFINED.

Returns:

The condition result value which is the inverse of this value.

invert

public static ConditionResult invert(ConditionResult r)

Retrieves the condition result value which is the inverse of the provided result. The inverse of TRUE is FALSE, and vice-versa. The inverse of UNDEFINED is UNDEFINED.

Parameters:

r - The condition result value for which to retrieve the inverse value. It must not be null.

Returns:

The condition result value which is the inverse of the provided result.

toString

public java.lang.String toString()

Retrieves a string representation of this condition result value.

Overrides:

toString in class java.lang.Enum<ConditionResult>

Returns:

A string representation of this condition result value.