Module io.ebean.core

Package io.ebeaninternal.api

Enum SpiQuery.Type

java.lang.Object

java.lang.Enum<SpiQuery.Type>

io.ebeaninternal.api.SpiQuery.Type

All Implemented Interfaces:

Serializable, Comparable<SpiQuery.Type>

Enclosing interface:

SpiQuery<T>

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

The type of query result.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTRIBUTE	Find single attribute.
ATTRIBUTE_SET	Find single attribute set.
BEAN	Find by Id or unique returning a single bean.
COUNT	Find rowCount.
DELETE	Delete query.
EXISTS	Find exists.
ID_LIST	Find the Id's.
ITERATE	Find iterate type query - findEach(), findIterate() etc.
LIST	Find returning a List.
MAP	Find returning a Map.
SET	Find returning a Set.
SQ_EX	A sub-query expression used as part of where clause.
SQ_EXISTS	A sub-query used as part of an exists where clause.
UPDATE	Update query.

Method Summary

Modifier and Type	Method	Description
boolean	defaultSelect()	Return true if this allows default select clause.
boolean	isUpdate()	Return true if this is an Update or Delete query (not read only).
String	label()
String	profileEventId()
static SpiQuery.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpiQuery.Type[]	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

BEAN

public static final SpiQuery.Type BEAN

Find by Id or unique returning a single bean.

LIST

public static final SpiQuery.Type LIST

Find returning a List.

SET

public static final SpiQuery.Type SET

Find returning a Set.

MAP

public static final SpiQuery.Type MAP

Find returning a Map.

ITERATE

public static final SpiQuery.Type ITERATE

Find iterate type query - findEach(), findIterate() etc.

ID_LIST

public static final SpiQuery.Type ID_LIST

Find the Id's.

EXISTS

public static final SpiQuery.Type EXISTS

Find exists.

ATTRIBUTE

public static final SpiQuery.Type ATTRIBUTE

Find single attribute.

ATTRIBUTE_SET

public static final SpiQuery.Type ATTRIBUTE_SET

Find single attribute set.

COUNT

public static final SpiQuery.Type COUNT

Find rowCount.

SQ_EXISTS

public static final SpiQuery.Type SQ_EXISTS

A sub-query used as part of an exists where clause.

SQ_EX

public static final SpiQuery.Type SQ_EX

A sub-query expression used as part of where clause.

DELETE

public static final SpiQuery.Type DELETE

Delete query.

UPDATE

public static final SpiQuery.Type UPDATE

Update query.

Method Details

values

public static SpiQuery.Type[] 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.Type 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

isUpdate

public boolean isUpdate()

Return true if this is an Update or Delete query (not read only).

defaultSelect

public boolean defaultSelect()

Return true if this allows default select clause.

profileEventId

public String profileEventId()

label

public String label()