jadex.commons

Enum Boolean3

java.lang.Object

java.lang.Enum<Boolean3>

jadex.commons.Boolean3

All Implemented Interfaces:

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

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

A three valued boolean to be used in annotations as they do not allow null values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE The false value.
NULL The undefined value.
TRUE The true value.

Method Summary

Modifier and Type	Method and Description
boolean	isTrue() Check if explicitly set to true, i.e.
java.lang.Boolean	toBoolean() Convert the three valued boolean to a two valued boolean object.
static Boolean3	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Boolean3[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final Boolean3 NULL

The undefined value.

FALSE

public static final Boolean3 FALSE

The false value.

TRUE

public static final Boolean3 TRUE

The true value.

Method Detail

values

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

Returns:

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

valueOf

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

toBoolean

public java.lang.Boolean toBoolean()

Convert the three valued boolean to a two valued boolean object.

isTrue

public boolean isTrue()

Check if explicitly set to true, i.e. neither FALSE nor NULL.