com.speedment.runtime.field.predicate

Enum Inclusion

java.lang.Object

java.lang.Enum<Inclusion>

com.speedment.runtime.field.predicate.Inclusion

All Implemented Interfaces:

Serializable, Comparable<Inclusion>

public enum Inclusion
extends Enum<Inclusion>

Determines if a range of resuls should be start and/or end-inclusive.

For an example, take the series [1 2 3 4 5]. If we select the range (2, 4) from this series, we will get the following results:

Enum Constant	Included Elements
START_INCLUSIVE_END_INCLUSIVE	[2, 3, 4]
START_INCLUSIVE_END_EXCLUSIVE	[2, 3]
START_EXCLUSIVE_END_INCLUSIVE	[3, 4]
START_EXCLUSIVE_END_EXCLUSIVE	[3]

Since:

2.2.0

Author:

Per Minborg, Emil Forslund

Enum Constant Summary

Enum Constants

Enum Constant and Description
START_EXCLUSIVE_END_EXCLUSIVE
START_EXCLUSIVE_END_INCLUSIVE
START_INCLUSIVE_END_EXCLUSIVE
START_INCLUSIVE_END_INCLUSIVE

Method Summary

Modifier and Type	Method and Description
boolean	isEndInclusive() Returns true if the last element in the range should be included, else false.
boolean	isStartInclusive() Returns true if the first element in the range should be included, else false.
static Inclusion	valueOf(String name) Returns the enum constant of this type with the specified name.
static Inclusion[]	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

START_INCLUSIVE_END_INCLUSIVE

public static final Inclusion START_INCLUSIVE_END_INCLUSIVE

START_INCLUSIVE_END_EXCLUSIVE

public static final Inclusion START_INCLUSIVE_END_EXCLUSIVE

START_EXCLUSIVE_END_INCLUSIVE

public static final Inclusion START_EXCLUSIVE_END_INCLUSIVE

START_EXCLUSIVE_END_EXCLUSIVE

public static final Inclusion START_EXCLUSIVE_END_EXCLUSIVE

Method Detail

values

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

Returns:

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

valueOf

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

isStartInclusive

public boolean isStartInclusive()

Returns true if the first element in the range should be included, else false.

Returns:

true if start is included, else false

isEndInclusive

public boolean isEndInclusive()

Returns true if the last element in the range should be included, else false.

Returns:

true if end is included, else false