Package org.hibernate.query.sqm.produce.function

Enum Class FunctionParameterType

java.lang.Object

java.lang.Enum<FunctionParameterType>

org.hibernate.query.sqm.produce.function.FunctionParameterType

All Implemented Interfaces:

Serializable, Comparable<FunctionParameterType>, java.lang.constant.Constable

public enum FunctionParameterType
extends Enum<FunctionParameterType>

A mini-"type system" for HQL function parameters.

Note that typical database type systems have relatively few types, and lots of implicit type conversion between them. So we can be pretty forgiving here.

See Also:

• ArgumentTypesValidator

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	Indicates a parameter that accepts any type
BOOLEAN	Indicates that the argument should be of type SqlTypes.BOOLEAN or a logical expression (predicate)
COLLATION	A collation, used by the collate() function
COMPARABLE	Any type with an order (numeric, string, and temporal types)
DATE
INTEGER
NO_UNTYPED	Indicates a parameter that accepts any type, except untyped expressions like null literals
NUMERIC
SPATIAL	Indicates that the argument should be a spatial type
STRING
STRING_OR_CLOB
TEMPORAL
TEMPORAL_UNIT	A temporal unit, used by the extract() function, and some native database functions
TIME
TRIM_SPEC	A trim specification, for trimming and padding functions

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRING

public static final FunctionParameterType STRING

See Also:

• SqlTypes.isCharacterType(int)

NUMERIC

public static final FunctionParameterType NUMERIC

See Also:

• SqlTypes.isNumericType(int)

INTEGER

public static final FunctionParameterType INTEGER

See Also:

• SqlTypes.isIntegral(int)

TEMPORAL

public static final FunctionParameterType TEMPORAL

See Also:

• SqlTypes.isTemporalType(int)

DATE

public static final FunctionParameterType DATE

See Also:

• SqlTypes.hasDatePart(int)

TIME

public static final FunctionParameterType TIME

See Also:

• SqlTypes.hasTimePart(int)

BOOLEAN

public static final FunctionParameterType BOOLEAN

Indicates that the argument should be of type SqlTypes.BOOLEAN or a logical expression (predicate)

ANY

public static final FunctionParameterType ANY

Indicates a parameter that accepts any type

TEMPORAL_UNIT

public static final FunctionParameterType TEMPORAL_UNIT

A temporal unit, used by the extract() function, and some native database functions

See Also:

• TemporalUnit
• SqmExtractUnit
• SqmDurationUnit

TRIM_SPEC

public static final FunctionParameterType TRIM_SPEC

A trim specification, for trimming and padding functions

See Also:

• SqmTrimSpecification

COLLATION

public static final FunctionParameterType COLLATION

A collation, used by the collate() function

See Also:

• SqmCollation

COMPARABLE

public static final FunctionParameterType COMPARABLE

Any type with an order (numeric, string, and temporal types)

STRING_OR_CLOB

public static final FunctionParameterType STRING_OR_CLOB

See Also:

• SqlTypes.isCharacterOrClobType(int)

SPATIAL

public static final FunctionParameterType SPATIAL

Indicates that the argument should be a spatial type

See Also:

• SqlTypes.isSpatialType(int)

NO_UNTYPED

public static final FunctionParameterType NO_UNTYPED

Indicates a parameter that accepts any type, except untyped expressions like null literals

Method Details

values

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