Package io.permazen.util

Enum Class BoundType

java.lang.Object

java.lang.Enum<BoundType>

io.permazen.util.BoundType

All Implemented Interfaces:

Serializable, Comparable<BoundType>, Constable

public enum BoundType
extends Enum<BoundType>

Upper and lower bound types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUSIVE	The bound is exclusive.
INCLUSIVE	The bound is inclusive.
NONE	There is no bound.

Method Summary

Modifier and Type	Method	Description
Boolean	isInclusive()	Get a Boolean corresponding to this instance: true for INCLUSIVE, false for EXCLUSIVE, or null for NONE.
static BoundType	of(boolean inclusive)	Returns INCLUSIVE or EXCLUSIVE based on the given boolean.
static BoundType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BoundType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INCLUSIVE

public static final BoundType INCLUSIVE

The bound is inclusive.

EXCLUSIVE

public static final BoundType EXCLUSIVE

The bound is exclusive.

NONE

public static final BoundType NONE

There is no bound.

Method Details

values

public static BoundType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BoundType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

of

public static BoundType of(boolean inclusive)

Returns INCLUSIVE or EXCLUSIVE based on the given boolean.

Parameters:

inclusive - true for INCLUSIVE, false for EXCLUSIVE

Returns:

the corresponding BoundType

isInclusive

public Boolean isInclusive()

Get a Boolean corresponding to this instance: true for INCLUSIVE, false for EXCLUSIVE, or null for NONE.

Returns:

boolean representation of this bound type