Module com.speedment.common.function

Package com.speedment.common.function

Enum OptionalBoolean

java.lang.Object

java.lang.Enum<OptionalBoolean>

com.speedment.common.function.OptionalBoolean

All Implemented Interfaces:

Serializable, Comparable<OptionalBoolean>

public enum OptionalBoolean
extends Enum<OptionalBoolean>

An Optional specialized for primitive boolean values.

Since:

1.0.0

Author:

Emil Forslund

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY
FALSE
TRUE

Method Summary

Modifier and Type	Method	Description
static OptionalBoolean	empty()
OptionalBoolean	filter(BooleanPredicate predicate)	If a value is present, and the value matches the given predicate, return a BooleanOptional describing the value, otherwise return an empty BooleanOptional.
boolean	getAsBoolean()
abstract void	ifPresent(BooleanConsumer consumer)
abstract boolean	isPresent()
static OptionalBoolean	of(boolean bool)
static OptionalBoolean	ofNullable(Boolean bool)
boolean	orElse(boolean ifEmpty)
abstract <T extends Throwable> boolean	orElseThrow(Supplier<T> thrower)
static OptionalBoolean	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OptionalBoolean[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FALSE

public static final OptionalBoolean FALSE

TRUE

public static final OptionalBoolean TRUE

EMPTY

public static final OptionalBoolean EMPTY

Method Detail

values

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

Returns:

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

valueOf

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

empty

public static OptionalBoolean empty()

of

public static OptionalBoolean of(boolean bool)

ofNullable

public static OptionalBoolean ofNullable(Boolean bool)

filter

public OptionalBoolean filter(BooleanPredicate predicate)

If a value is present, and the value matches the given predicate, return a BooleanOptional describing the value, otherwise return an empty BooleanOptional.

Parameters:

predicate - a predicate to apply to the value, if present

Returns:

a BooleanOptional describing the value of this BooleanOptional if a value is present and the value matches the given predicate, otherwise an empty BooleanOptional

Throws:

NullPointerException - if the predicate is null

getAsBoolean

public boolean getAsBoolean()

orElse

public boolean orElse(boolean ifEmpty)

orElseThrow

public abstract <T extends Throwable> boolean orElseThrow(Supplier<T> thrower)
                                                   throws T extends Throwable

Throws:

T extends Throwable

isPresent

public abstract boolean isPresent()

ifPresent

public abstract void ifPresent(BooleanConsumer consumer)