Package org.forgerock.opendj.ldap
Enum ConditionResult
- java.lang.Object
-
- java.lang.Enum<ConditionResult>
-
- org.forgerock.opendj.ldap.ConditionResult
-
- All Implemented Interfaces:
Serializable
,Comparable<ConditionResult>
public enum ConditionResult extends Enum<ConditionResult>
The result of a tri-state logical expression. Condition results are used to represent the result of a conditional evaluation that can yield three possible values:FALSE
(i.e. "no"),TRUE
(i.e. "yes"), orUNDEFINED
(i.e. "maybe"). A result ofUNDEFINED
indicates that further investigation may be required.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConditionResult
and()
Returns the logical AND of zero condition results, which is alwaysTRUE
.ConditionResult
and(ConditionResult r)
Returns the logical AND of the this condition result with the provided condition result, which isTRUE
if both of the condition results areTRUE
,FALSE
if at least one of them isFALSE
, andUNDEFINED
otherwise.static ConditionResult
and(ConditionResult... results)
Returns the logical AND of the provided condition results, which isTRUE
if all of the provided condition results areTRUE
,FALSE
if at least one of them isFALSE
, andUNDEFINED
otherwise.static ConditionResult
and(ConditionResult r1, ConditionResult r2)
Returns the logical AND of the provided condition results, which isTRUE
if both of the provided condition results areTRUE
,FALSE
if at least one of them isFALSE
, andUNDEFINED
otherwise.ConditionResult
not()
Returns the logical NOT of this condition result, which isTRUE
if this condition result isFALSE
,TRUE
if it isFALSE
, andUNDEFINED
otherwise.static ConditionResult
not(ConditionResult r)
Returns the logical NOT of the provided condition result, which isTRUE
if the provided condition result isFALSE
,TRUE
if it isFALSE
, andUNDEFINED
otherwise.static ConditionResult
or()
Returns the logical OR of zero condition results, which is alwaysFALSE
.ConditionResult
or(ConditionResult r)
Returns the logical OR of the this condition result with the provided condition result, which isFALSE
if both of the condition results areFALSE
,TRUE
if at least one of them isTRUE
, andUNDEFINED
otherwise.static ConditionResult
or(ConditionResult... results)
Returns the logical OR of the provided condition results, which isFALSE
if all of the provided condition results areFALSE
,TRUE
if at least one of them isTRUE
, andUNDEFINED
otherwise.static ConditionResult
or(ConditionResult r1, ConditionResult r2)
Returns the logical OR of the provided condition results, which isFALSE
if both of the provided condition results areFALSE
,TRUE
if at least one of them isTRUE
, andUNDEFINED
otherwise.boolean
toBoolean()
Converts this condition result to a boolean value.String
toString()
Returns the string representation of this condition result.static ConditionResult
valueOf(boolean b)
Returns the condition result which is equivalent to the provided boolean value.static ConditionResult
valueOf(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.
-
-
-
Enum Constant Detail
-
FALSE
public static final ConditionResult FALSE
Indicates that the condition evaluated tofalse
.
-
UNDEFINED
public static final ConditionResult UNDEFINED
Indicates that the condition could not be evaluated and its result is undefined.
-
TRUE
public static final ConditionResult TRUE
Indicates that the condition evaluated totrue
.
-
-
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(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
-
and
public static ConditionResult and()
Returns the logical AND of zero condition results, which is alwaysTRUE
.- Returns:
- The logical OR of zero condition results, which is always
TRUE
.
-
and
public static ConditionResult and(ConditionResult... results)
Returns the logical AND of the provided condition results, which isTRUE
if all of the provided condition results areTRUE
,FALSE
if at least one of them isFALSE
, andUNDEFINED
otherwise. Note thatTRUE
is returned if the provided list of results is empty.- Parameters:
results
- The condition results to be compared.- Returns:
- The logical AND of the provided condition results.
-
and
public static ConditionResult and(ConditionResult r1, ConditionResult r2)
Returns the logical AND of the provided condition results, which isTRUE
if both of the provided condition results areTRUE
,FALSE
if at least one of them isFALSE
, andUNDEFINED
otherwise.- Parameters:
r1
- The first condition result to be compared.r2
- The second condition result to be compared.- Returns:
- The logical AND of the provided condition results.
-
and
public ConditionResult and(ConditionResult r)
Returns the logical AND of the this condition result with the provided condition result, which isTRUE
if both of the condition results areTRUE
,FALSE
if at least one of them isFALSE
, andUNDEFINED
otherwise.- Parameters:
r
- The condition result to be compared with this one.- Returns:
- The logical AND of the two condition results.
-
not
public static ConditionResult not(ConditionResult r)
Returns the logical NOT of the provided condition result, which isTRUE
if the provided condition result isFALSE
,TRUE
if it isFALSE
, andUNDEFINED
otherwise.- Parameters:
r
- The condition result to invert.- Returns:
- The logical NOT of the provided condition result.
-
not
public ConditionResult not()
Returns the logical NOT of this condition result, which isTRUE
if this condition result isFALSE
,TRUE
if it isFALSE
, andUNDEFINED
otherwise.- Returns:
- The logical NOT of this condition result.
-
or
public static ConditionResult or()
Returns the logical OR of zero condition results, which is alwaysFALSE
.- Returns:
- The logical OR of zero condition results, which is always
FALSE
.
-
or
public static ConditionResult or(ConditionResult... results)
Returns the logical OR of the provided condition results, which isFALSE
if all of the provided condition results areFALSE
,TRUE
if at least one of them isTRUE
, andUNDEFINED
otherwise. Note thatFALSE
is returned if the provided list of results is empty.- Parameters:
results
- The condition results to be compared.- Returns:
- The logical OR of the provided condition results.
-
or
public static ConditionResult or(ConditionResult r1, ConditionResult r2)
Returns the logical OR of the provided condition results, which isFALSE
if both of the provided condition results areFALSE
,TRUE
if at least one of them isTRUE
, andUNDEFINED
otherwise.- Parameters:
r1
- The first condition result to be compared.r2
- The second condition result to be compared.- Returns:
- The logical OR of the provided condition results.
-
or
public ConditionResult or(ConditionResult r)
Returns the logical OR of the this condition result with the provided condition result, which isFALSE
if both of the condition results areFALSE
,TRUE
if at least one of them isTRUE
, andUNDEFINED
otherwise.- Parameters:
r
- The condition result to be compared with this one.- Returns:
- The logical OR of the two condition results.
-
valueOf
public static ConditionResult valueOf(boolean b)
Returns the condition result which is equivalent to the provided boolean value.- Parameters:
b
- The boolean value.- Returns:
TRUE
ifb
wastrue
, otherwiseFALSE
.
-
toBoolean
public boolean toBoolean()
Converts this condition result to a boolean value.FALSE
andUNDEFINED
are both converted tofalse
, andTRUE
is converted totrue
.- Returns:
- The boolean equivalent of this condition result.
-
toString
public String toString()
Returns the string representation of this condition result.- Overrides:
toString
in classEnum<ConditionResult>
- Returns:
- The string representation of his condition result.
-
-