org.kocakosm.pitaya.util

Class Booleans

java.lang.Object

org.kocakosm.pitaya.util.Booleans

public final class Booleans
extends Object

Static utility methods that operate on or return boolean values.

Author:

Osman KOCAK

Field Summary

Fields

Modifier and Type	Field and Description
static Boolean	FALSE The Boolean object corresponding to the primitive value false.
static Boolean	TRUE The Boolean object corresponding to the primitive value true.

Method Summary

Methods

Modifier and Type	Method and Description
static Boolean	and(Boolean... bools) Performs a logical "and" on the given values, that is, this method returns true if, and only if, all the given Boolean values are true, and false in all other cases.
static boolean	isFalse(Boolean bool) Returns true if and only if the given Boolean object is false.
static boolean	isNotFalse(Boolean bool) Returns true if and only if the given Boolean object is not false.
static boolean	isNotTrue(Boolean bool) Returns true if and only if the given Boolean object is not true.
static boolean	isTrue(Boolean bool) Returns true if and only if the given Boolean object is true.
static Boolean	not(Boolean bool) Returns the negation of the given Boolean.
static Boolean	or(Boolean... bools) Performs a logical "or" on the given values, that is, this method returns true if, and only if, at least one of the given Boolean values is true, and false in all other cases.
static Integer	toInteger(boolean bool) Returns 1 if bool is true, 0 otherwise.
static Integer	toInteger(Boolean bool) Returns 1 if bool is true, 0 if false.
static String	toString(boolean bool) Returns the given boolean's String representation.
static Boolean	valueOf(boolean bool) Returns the Boolean instance representing the given primitive boolean value.
static Boolean	valueOf(int i) Converts the given int into a Boolean using the convention that zero represents false and all other values represent true.
static Boolean	valueOf(Integer i) Converts the given Integer into a Boolean using the convention that zero represents false and all other values represent true.
static Boolean	valueOf(String bool) Parses the given String into a Boolean.
static Boolean	xor(Boolean... bools) Performs an "exclusive or" on the given values, that is, this method returns true if, and only if, only one of the given Boolean values is true, and false in all other cases.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRUE

public static final Boolean TRUE

The Boolean object corresponding to the primitive value true.

FALSE

public static final Boolean FALSE

The Boolean object corresponding to the primitive value false.

Method Detail

and

public static Boolean and(Boolean... bools)

Performs a logical "and" on the given values, that is, this method returns true if, and only if, all the given Boolean values are true, and false in all other cases.

Parameters:

bools - the Boolean values.

Returns:

the result of the logical "and" on the given values.

Throws:

NullPointerException - if bools is null or if it contains a null reference.

IllegalArgumentException - if bools is empty.

or

public static Boolean or(Boolean... bools)

Performs a logical "or" on the given values, that is, this method returns true if, and only if, at least one of the given Boolean values is true, and false in all other cases.

Parameters:

bools - the Boolean values.

Returns:

the result of the logical "or" on the given values.

Throws:

NullPointerException - if bools is null or if it contains a null reference.

IllegalArgumentException - if bools is empty.

not

public static Boolean not(Boolean bool)

Returns the negation of the given Boolean.

Parameters:

bool - the Boolean to negate.

Returns:

the negation of the given Boolean.

Throws:

NullPointerException - if bool is null.

xor

public static Boolean xor(Boolean... bools)

Performs an "exclusive or" on the given values, that is, this method returns true if, and only if, only one of the given Boolean values is true, and false in all other cases.

Parameters:

bools - the Boolean values.

Returns:

the result of the "exclusive or" on the given values.

Throws:

NullPointerException - if bools is null or if it contains a null reference.

IllegalArgumentException - if bools is empty.

isFalse

public static boolean isFalse(Boolean bool)

Returns true if and only if the given Boolean object is false.

Parameters:

bool - the Boolean to test, may be null.

Returns:

whether the given Boolean is false.

isNotFalse

public static boolean isNotFalse(Boolean bool)

Returns true if and only if the given Boolean object is not false.

Parameters:

bool - the Boolean to test, may be null.

Returns:

whether the given Boolean is not false.

isTrue

public static boolean isTrue(Boolean bool)

Returns true if and only if the given Boolean object is true.

Parameters:

bool - the Boolean to test, may be null.

Returns:

whether the given Boolean is true.

isNotTrue

public static boolean isNotTrue(Boolean bool)

Returns true if and only if the given Boolean object is not true.

Parameters:

bool - the Boolean to test, may be null.

Returns:

whether the given Boolean is not true.

valueOf

public static Boolean valueOf(String bool)

Parses the given String into a Boolean. This method returns true if the given String contains "true", "yes", "1" or "on".

Parameters:

bool - the String to parse.

Returns:

the parsed Boolean.

Throws:

NullPointerException - if bool is null.

valueOf

public static Boolean valueOf(int i)

Converts the given int into a Boolean using the convention that zero represents false and all other values represent true.

Parameters:

i - the int to convert.

Returns:

false if i == 0, true otherswise.

valueOf

public static Boolean valueOf(Integer i)

Converts the given Integer into a Boolean using the convention that zero represents false and all other values represent true.

Parameters:

i - the int to convert.

Returns:

false if i == 0, true otherswise.

Throws:

NullPointerException - if i is null.

valueOf

public static Boolean valueOf(boolean bool)

Returns the Boolean instance representing the given primitive boolean value.

Parameters:

bool - the boolean value to convert.

Returns:

the Boolean instance representing the given value.

toInteger

public static Integer toInteger(boolean bool)

Returns 1 if bool is true, 0 otherwise.

Parameters:

bool - the boolean value to convert.

Returns:

1 if bool is true, 0 otherwise.

toInteger

public static Integer toInteger(Boolean bool)

Returns 1 if bool is true, 0 if false.

Parameters:

bool - the Boolean instance to convert.

Returns:

1 if bool is true, 0 if false.

Throws:

NullPointerException - if bool is null.

toString

public static String toString(boolean bool)

Returns the given boolean's String representation.

Parameters:

bool - the boolean value to convert.

Returns:

bool's String representation.