Enum Class CommentTarget

java.lang.Object

java.lang.Enum<CommentTarget>

org.hibernate.dialect.schema.spi.CommentTarget

All Implemented Interfaces:

Serializable, Comparable<CommentTarget>, Constable

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

Identifies the database object receiving a schema-export comment.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
TABLE
TABLE_COLUMN
USER_DEFINED_TYPE
USER_DEFINED_TYPE_COLUMN

Method Summary

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

TABLE

public static final CommentTarget TABLE

TABLE_COLUMN

public static final CommentTarget TABLE_COLUMN

USER_DEFINED_TYPE

public static final CommentTarget USER_DEFINED_TYPE

USER_DEFINED_TYPE_COLUMN

public static final CommentTarget USER_DEFINED_TYPE_COLUMN

Method Details

values

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