Package org.spongepowered.api.util

Class OptBool

java.lang.Object

org.spongepowered.api.util.OptBool

public final class OptBool
extends Object

Utility for working with Optional<Boolean>s.

This also saves memory by holding three static instances of Optional<Boolean>, which represents the possible states it can have.

Field Summary

Fields

Modifier and Type	Field	Description
static final Optional<Boolean>	EMPTY	The absent value.
static final Optional<Boolean>	FALSE	The false value.
static final Optional<Boolean>	TRUE	The true value.

Method Summary

Modifier and Type	Method	Description
static Optional<Boolean>	of(boolean bool)	Constructs a new Optional<Boolean> from the given boolean.
static Optional<Boolean>	of(@Nullable Boolean bool)	Constructs a new Optional<Boolean> from the given Boolean.
static Optional<Boolean>	of(Optional<Boolean> bool)	Coerces the given Optional<Boolean> into one of the three stored states.

Methods inherited from class java.lang.Object

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

Field Details

TRUE

public static final Optional<Boolean> TRUE

The true value.

FALSE

public static final Optional<Boolean> FALSE

The false value.

EMPTY

public static final Optional<Boolean> EMPTY

The absent value.

Also a shorthand for constructing instances with Optional.<Boolean>empty().

Method Details

of

public static Optional<Boolean> of(boolean bool)

Constructs a new Optional<Boolean> from the given boolean.

Parameters:

bool - The boolean

Returns:

The constructed Optional

of

public static Optional<Boolean> of(@Nullable Boolean bool)

Constructs a new Optional<Boolean> from the given Boolean.

Parameters:

bool - The boolean

Returns:

The constructed Optional, or Optional.empty()

of

public static Optional<Boolean> of(Optional<Boolean> bool)

Coerces the given Optional<Boolean> into one of the three stored states.

Parameters:

bool - The boolean

Returns:

The constructed Optional, or Optional.empty()