net.sf.mmm.util.lang.api

Enum Conjunction

java.lang.Object

java.lang.Enum<Conjunction>

net.sf.mmm.util.lang.api.Conjunction

All Implemented Interfaces:

Serializable, Comparable<Conjunction>, AttributeReadValue<String>, Datatype, EnumType<String>, SimpleDatatype<String>

public enum Conjunction
extends Enum<Conjunction>
implements EnumType<String>

A Conjunction represents a function that maps a list of boolean arguments to one boolean result.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND This conjunction is true if and only if all arguments are true.
NAND This is the negation of AND.
NOR This is the negation of OR.
OR This conjunction is true if and only if at least one argument is true.

Field Summary

Fields

Modifier and Type	Field and Description
private String	title
private String	value

Method Summary

Modifier and Type	Method and Description
boolean	eval(boolean... arguments) This method evaluates this conjunction for the given boolean arguments.
abstract boolean	evalEmpty()
abstract Boolean	evalSingle(boolean argument)
static Conjunction	fromValue(String value) This method gets the Conjunction with the given value.
String	getValue() This method returns the raw value of this datatype.
boolean	isNegation()
abstract Conjunction	negate()
String	toString() Returns the official String representation of this Datatype.
static Conjunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Conjunction[]	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

AND

public static final Conjunction AND

This conjunction is true if and only if all arguments are true.

OR

public static final Conjunction OR

This conjunction is true if and only if at least one argument is true.

NAND

public static final Conjunction NAND

This is the negation of AND. It is only true if at least one argument is false.

NOR

public static final Conjunction NOR

This is the negation of OR. It is only true if all arguments are false .

Field Detail

value

private final String value

title

private final String title

Method Detail

values

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

Returns:

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

valueOf

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

eval

public final boolean eval(boolean... arguments)

This method evaluates this conjunction for the given boolean arguments.

Parameters:

arguments - are the boolean values to evaluate.

Returns:

the result of this conjunction applied to the given arguments.

Since:

2.0.0

evalSingle

public abstract Boolean evalSingle(boolean argument)

Parameters:

argument - is a literal boolean argument.

Returns:

Boolean.TRUE if eval(boolean...) will return true if any of the given arguments has the value of the given argument, Boolean.FALSE if eval(boolean...) will return false if any of the given arguments has the value of the given argument, null otherwise.

Since:

7.1.0

evalEmpty

public abstract boolean evalEmpty()

Returns:

the result of eval(boolean...) for no argument (an empty argument array).

Since:

7.1.0

getValue

public String getValue()

Description copied from interface: SimpleDatatype

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<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

isNegation

public boolean isNegation()

Returns:

true if NOR or NAND, false otherwise.

Since:

3.0.0

negate

public abstract Conjunction negate()

Returns:

the negation of this Conjunction that evaluates to the negated result.

Since:

7.1.0

toString

public String toString()

Description copied from interface: Datatype

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<Conjunction>

Returns:

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

fromValue

public static Conjunction fromValue(String value)

This method gets the Conjunction with the given value.

Parameters:

value - is the value of the requested Conjunction.

Returns:

the requested Conjunction.