Module io.ebean.core

Package io.ebeaninternal.api

Enum SpiQuery.TemporalMode

java.lang.Object

java.lang.Enum<SpiQuery.TemporalMode>

io.ebeaninternal.api.SpiQuery.TemporalMode

All Implemented Interfaces:

Serializable, Comparable<SpiQuery.TemporalMode>

Enclosing interface:

SpiQuery<T>

public static enum SpiQuery.TemporalMode
extends Enum<SpiQuery.TemporalMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AS_OF	Query runs 'As Of' a given date time.
CURRENT	Query runs against current data (normal).
SOFT_DELETED	Includes soft deletes rows in the result.
VERSIONS	Query runs potentially returning many versions of the same bean.

Method Summary

Modifier and Type	Method	Description
boolean	isHistory()	Return true if this is a history query.
static SpiQuery.TemporalMode	of(SpiQuery<?> query)	Return the mode of the query of if null return CURRENT mode.
static SpiQuery.TemporalMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpiQuery.TemporalMode[]	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 Details

SOFT_DELETED

public static final SpiQuery.TemporalMode SOFT_DELETED

Includes soft deletes rows in the result.

CURRENT

public static final SpiQuery.TemporalMode CURRENT

Query runs against current data (normal).

VERSIONS

public static final SpiQuery.TemporalMode VERSIONS

Query runs potentially returning many versions of the same bean.

AS_OF

public static final SpiQuery.TemporalMode AS_OF

Query runs 'As Of' a given date time.

Method Details

values

public static SpiQuery.TemporalMode[] values()

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

Returns:

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

valueOf

public static SpiQuery.TemporalMode 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

isHistory

public boolean isHistory()

Return true if this is a history query.

of

public static SpiQuery.TemporalMode of(SpiQuery<?> query)

Return the mode of the query of if null return CURRENT mode.