Enum Class PrimaryTableReferenceKind

java.lang.Object

java.lang.Enum<PrimaryTableReferenceKind>

org.hibernate.dialect.sql.ast.spi.PrimaryTableReferenceKind

All Implemented Interfaces:

Serializable, Comparable<PrimaryTableReferenceKind>, Constable

public enum PrimaryTableReferenceKind
extends Enum<PrimaryTableReferenceKind>

The semantic kind of primary table reference.

Hibernate supplies this classification to AbstractSqlAstTranslator.renderPrimaryTableReferencePrefix(PrimaryTableReferenceContext) before it renders the primary reference of a table group. It lets a translator choose an introducer without inspecting internal SQL AST implementations.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FUNCTION	A function used as a table source, for example unnest(tags) u(tag).
NAMED	A physical named table or view, for example book b.
QUERY_PART	A derived query part, for example (select ... from ...) q.
VALUES	A derived values table, for example (values (1), (2)) v(id).

Method Summary

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

NAMED

public static final PrimaryTableReferenceKind NAMED

A physical named table or view, for example book b.

QUERY_PART

public static final PrimaryTableReferenceKind QUERY_PART

A derived query part, for example (select ... from ...) q.

VALUES

public static final PrimaryTableReferenceKind VALUES

A derived values table, for example (values (1), (2)) v(id).

FUNCTION

public static final PrimaryTableReferenceKind FUNCTION

A function used as a table source, for example unnest(tags) u(tag).

Method Details

values

public static PrimaryTableReferenceKind[] 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 PrimaryTableReferenceKind 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