org.protempa.proposition.value

Class BooleanValue

java.lang.Object

org.protempa.proposition.value.BooleanValue

All Implemented Interfaces:

Serializable, Value, ValueVisitable

public final class BooleanValue
extends Object
implements Value, Serializable

A boolean value.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BooleanValue	FALSE
static BooleanValue	TRUE

Constructor Summary

Constructors

Constructor and Description
BooleanValue(boolean val) Creates a new boolean value.
BooleanValue(Boolean val) Creates a boolean value (true or false).

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor valueVisitor) Performs some processing on a value.
ValueBuilder	asBuilder()
boolean	booleanValue() Returns the Java boolean corresponding to this object.
ValueComparator	compare(Value val) Returns ValueComparator.UNKNOWN, as boolean values do not have a natural order, unless the provided value is a value list, for which this method tests for membership in the list.
boolean	equals(Object obj)
String	format(Format format) Returns a string representing this value, formatted by the provided Format.
Boolean	getBoolean() Returns the Java Boolean corresponding to this object.
String	getFormatted() Returns a string representing this value for display purposes.
ValueType	getType() Returns this object's type, guaranteed not null.
int	hashCode()
static BooleanValue	parse(String str) Parses a boolean from a string.
BooleanValue	replace() Returns a value from a cache that is equal to this one, if such a value exists.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TRUE

public static final BooleanValue TRUE

FALSE

public static final BooleanValue FALSE

Constructor Detail

BooleanValue

public BooleanValue(boolean val)

Creates a new boolean value. Use TRUE or FALSE instead.

Parameters:

val - a java boolean.

BooleanValue

public BooleanValue(Boolean val)

Creates a boolean value (true or false). Use TRUE or FALSE instead.

Parameters:

val - a Boolean object. If null, this BooleanValue object is set to false

Method Detail

parse

public static BooleanValue parse(String str)

Parses a boolean from a string. The parser expects "true" or "false" (case insensitive).

Parameters:

str - a string representing a boolean.

Returns:

a boolean value, or null if no boolean could be parsed.

replace

public BooleanValue replace()

Description copied from interface: Value

Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.

Specified by:

replace in interface Value

Returns:

a Value for which #equals(Value) is true.

getBoolean

public Boolean getBoolean()

Returns the Java Boolean corresponding to this object.

Returns:

Boolean.TRUE or Boolean.FALSE.

booleanValue

public boolean booleanValue()

Returns the Java boolean corresponding to this object.

Returns:

true or false.

getFormatted

public String getFormatted()

Description copied from interface: Value

Returns a string representing this value for display purposes.

Specified by:

getFormatted in interface Value

Returns:

a String. Guaranteed not null.

format

public String format(Format format)

Description copied from interface: Value

Returns a string representing this value, formatted by the provided Format.

Specified by:

format in interface Value

Parameters:

format - a Format. Passing in a null will result in the same behavior as Value.getFormatted().

Returns:

a String.

getType

public ValueType getType()

Description copied from interface: Value

Returns this object's type, guaranteed not null.

Specified by:

getType in interface Value

Returns:

a ValueType.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

accept

public void accept(ValueVisitor valueVisitor)

Description copied from interface: ValueVisitable

Performs some processing on a value.

Specified by:

accept in interface ValueVisitable

compare

public ValueComparator compare(Value val)

Returns ValueComparator.UNKNOWN, as boolean values do not have a natural order, unless the provided value is a value list, for which this method tests for membership in the list.

Specified by:

compare in interface Value

Parameters:

o - a Value.

Returns:

ValueComparator.UNKNOWN, if the provided value is not a value list. If the provided value is a value list, it returns ValueComparator.IN if this boolean value is a member and ValueComparator.NOT_IN if this boolean value is not a member.

asBuilder

public ValueBuilder asBuilder()

Specified by:

asBuilder in interface Value