Package org.hibernate.query.sqm

Enum FetchClauseType

java.lang.Object

java.lang.Enum<FetchClauseType>

org.hibernate.query.sqm.FetchClauseType

All Implemented Interfaces:

Serializable, Comparable<FetchClauseType>

public enum FetchClauseType
extends Enum<FetchClauseType>

The kind of fetch to use for the FETCH clause.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PERCENT_ONLY	Row count in percent FETCH FIRST n PERCENT ROWS ONLY.
PERCENT_WITH_TIES	Also fetches ties if the last value is not unique FETCH FIRST n PERCENT ROWS WITH TIES.
ROWS_ONLY	Exact row count like for LIMIT clause or FETCH FIRST n ROWS ONLY.
ROWS_WITH_TIES	Also fetches ties if the last value is not unique FETCH FIRST n ROWS WITH TIES.

Method Summary

Modifier and Type	Method	Description
static FetchClauseType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FetchClauseType[]	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

ROWS_ONLY

public static final FetchClauseType ROWS_ONLY

Exact row count like for LIMIT clause or FETCH FIRST n ROWS ONLY.

ROWS_WITH_TIES

public static final FetchClauseType ROWS_WITH_TIES

Also fetches ties if the last value is not unique FETCH FIRST n ROWS WITH TIES.

PERCENT_ONLY

public static final FetchClauseType PERCENT_ONLY

Row count in percent FETCH FIRST n PERCENT ROWS ONLY.

PERCENT_WITH_TIES

public static final FetchClauseType PERCENT_WITH_TIES

Also fetches ties if the last value is not unique FETCH FIRST n PERCENT ROWS WITH TIES.

Method Detail

values

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

Returns:

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

valueOf

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