org.macroing.cel4j.java.source.lexical

Enum BooleanLiteral

java.lang.Object

java.lang.Enum<BooleanLiteral>

org.macroing.cel4j.java.source.lexical.BooleanLiteral

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BooleanLiteral>, InputElement, Literal, Token, org.macroing.cit.java.util.node.Node

public enum BooleanLiteral
extends java.lang.Enum<BooleanLiteral>
implements Literal

A BooleanLiteral denotes the nonterminal symbol BooleanLiteral, as defined by the Java Language Specification.

If the Java Language Specification is updated in a way that affects the boolean type, this enum may be updated to reflect those changes. This means that new elements could be added. But it's highly unlikely.

Since:

1.0.0

Author:

Jörgen Lundgren

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE A BooleanLiteral representing false.
TRUE A BooleanLiteral representing true.

Method Summary

Modifier and Type	Method and Description
static BooleanLiteral	not(BooleanLiteral booleanLiteral) Returns a negated version of the given BooleanLiteral instance.
boolean	toBoolean() Returns a boolean representation of this BooleanLiteral instance.
java.lang.String	toString() Returns a String representation of this BooleanLiteral instance.
static BooleanLiteral	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BooleanLiteral[]	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

Methods inherited from interface org.macroing.cit.java.util.node.Node

accept, accept

Enum Constant Detail

FALSE

public static final BooleanLiteral FALSE

A BooleanLiteral representing false.

TRUE

public static final BooleanLiteral TRUE

A BooleanLiteral representing true.

Method Detail

values

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

Returns:

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

valueOf

public static BooleanLiteral 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 boolean toBoolean()

Returns a boolean representation of this BooleanLiteral instance.

Returns:

a boolean representation of this BooleanLiteral instance

toString

public java.lang.String toString()

Returns a String representation of this BooleanLiteral instance.

Overrides:

toString in class java.lang.Enum<BooleanLiteral>

Returns:

a String representation of this BooleanLiteral instance

not

public static BooleanLiteral not(BooleanLiteral booleanLiteral)

Returns a negated version of the given BooleanLiteral instance.

If booleanLiteral is null, a NullPointerException will be thrown.

If you import members from this class statically, the expression not(TRUE) will return FALSE.

Parameters:

booleanLiteral - the BooleanLiteral to negate

Returns:

a negated version of the given BooleanLiteral instance

Throws:

java.lang.NullPointerException - thrown if, and only if, booleanLiteral is null