Enum Class SelectQueryDescriptor.ResultKind

java.lang.Object

java.lang.Enum<SelectQueryDescriptor.ResultKind>

org.apache.cayenne.map.SelectQueryDescriptor.ResultKind

All Implemented Interfaces:

Serializable, Comparable<SelectQueryDescriptor.ResultKind>, Constable

Enclosing class:

SelectQueryDescriptor

public static enum SelectQueryDescriptor.ResultKind
extends Enum<SelectQueryDescriptor.ResultKind>

The kind of the objects that a select query fetches, see SelectQueryDescriptor.getResultKind().

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRAY	The arrays of the values of the multiple columns of a column query.
DATA_ROW	DataRows, for a query rooted in a DbEntity or fetching DataRows.
ENTITY	The persistent objects of the root ObjEntity.
SCALAR	The values of the single column of a column query.

Method Summary

Modifier and Type	Method	Description
static SelectQueryDescriptor.ResultKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SelectQueryDescriptor.ResultKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENTITY

public static final SelectQueryDescriptor.ResultKind ENTITY

The persistent objects of the root ObjEntity.

DATA_ROW

public static final SelectQueryDescriptor.ResultKind DATA_ROW

DataRows, for a query rooted in a DbEntity or fetching DataRows.

SCALAR

public static final SelectQueryDescriptor.ResultKind SCALAR

The values of the single column of a column query.

ARRAY

public static final SelectQueryDescriptor.ResultKind ARRAY

The arrays of the values of the multiple columns of a column query.

Method Details

values

public static SelectQueryDescriptor.ResultKind[] 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 SelectQueryDescriptor.ResultKind 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