net.sf.mmm.util.lang.api

Enum BooleanEnum

java.lang.Object

java.lang.Enum<BooleanEnum>

net.sf.mmm.util.lang.api.BooleanEnum

All Implemented Interfaces:

Serializable, Comparable<BooleanEnum>, AttributeReadValue<Boolean>, Datatype, SimpleDatatype<Boolean>

public enum BooleanEnum
extends Enum<BooleanEnum>
implements SimpleDatatype<Boolean>

A BooleanEnum represents a Boolean as enum type. This may seem pointless in the first place but is usable for annotations that can not have null values. However, in this case it is often desirable to express a default that is neither true nor false e.g. if the default can be determined from other values. In such case you can use BooleanEnum instead and NULL as default.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE Represents Boolean.FALSE.
NULL Repesents null.
TRUE Represents Boolean.TRUE.

Field Summary

Fields

Modifier and Type	Field and Description
private Boolean	value

Method Summary

Modifier and Type	Method and Description
static BooleanEnum	fromValue(Boolean value) This method gets the BooleanEnum for the given value.
Boolean	getValue() This method returns the raw value of this datatype.
boolean	isFalse() This method determines if this instance is FALSE.
boolean	isTrue() This method determines if this instance is TRUE.
String	toString() Returns the official String representation of this Datatype.
static BooleanEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static BooleanEnum[]	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 BooleanEnum TRUE

Represents Boolean.TRUE.

FALSE

public static final BooleanEnum FALSE

Represents Boolean.FALSE.

NULL

public static final BooleanEnum NULL

Repesents null.

Field Detail

value

private final Boolean value

See Also:

getValue()

Method Detail

values

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

Returns:

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

valueOf

public static BooleanEnum 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 name

NullPointerException - if the argument is null

getValue

public Boolean getValue()

This method returns the raw value of this datatype. This will typically be a standard datatype (like String, Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<Boolean>

Specified by:

getValue in interface SimpleDatatype<Boolean>

Returns:

the value of this datatype.

isTrue

public boolean isTrue()

This method determines if this instance is TRUE.

Returns:

true if TRUE, false otherwise.

isFalse

public boolean isFalse()

This method determines if this instance is FALSE.

Returns:

true if FALSE, false otherwise.

fromValue

public static BooleanEnum fromValue(Boolean value)

This method gets the BooleanEnum for the given value.

Parameters:

value - is the value of the requested BooleanEnum.

Returns:

the requested BooleanEnum.

toString

public String toString()

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class Enum<BooleanEnum>

Returns:

the official String representation to display the value of this Datatype.