Enum Class NameQualifierSupport

java.lang.Object

java.lang.Enum<NameQualifierSupport>

org.hibernate.engine.jdbc.env.spi.NameQualifierSupport

All Implemented Interfaces:

Serializable, Comparable<NameQualifierSupport>, Constable

@SPI(USE)
public enum NameQualifierSupport
extends Enum<NameQualifierSupport>

Describes whether qualified database object names admit catalogs, schemas, both namespace kinds, or neither.

This value does not define the catalog separator. A Dialect may report the same qualifier support as another database while using a different separator.

See Also:

• Dialect.getNameQualifierSupport()

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Both catalogs and schemas are supported.
CATALOG	Only catalogs are supported.
NONE	Neither catalogs nor schemas are supported.
SCHEMA	Only schemas are supported.

Method Summary

Modifier and Type	Method	Description
boolean	supportsCatalogs()	Report whether catalog qualification is supported.
boolean	supportsSchemas()	Report whether schema qualification is supported.
static NameQualifierSupport	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NameQualifierSupport[]	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

CATALOG

public static final NameQualifierSupport CATALOG

Only catalogs are supported.

SCHEMA

public static final NameQualifierSupport SCHEMA

Only schemas are supported.

BOTH

public static final NameQualifierSupport BOTH

Both catalogs and schemas are supported.

NONE

public static final NameQualifierSupport NONE

Neither catalogs nor schemas are supported.

Method Details

values

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

supportsCatalogs

public boolean supportsCatalogs()

Report whether catalog qualification is supported.

supportsSchemas

public boolean supportsSchemas()

Report whether schema qualification is supported.