Enum FunctionParameterType
- java.lang.Object
-
- java.lang.Enum<FunctionParameterType>
-
- org.hibernate.query.sqm.produce.function.FunctionParameterType
-
- All Implemented Interfaces:
Serializable
,Comparable<FunctionParameterType>
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
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANY
Indicates a parameter that accepts any typeBOOLEAN
Indicates that the argument should be of typeSqlTypes.BOOLEAN
or a logical expression (predicate)COLLATION
A collation, used by thecollate()
functionCOMPARABLE
Any type with an order (numeric, string, and temporal types)DATE
INTEGER
NUMERIC
STRING
STRING_OR_CLOB
TEMPORAL
TEMPORAL_UNIT
A temporal unit, used by theextract()
function, and some native database functionsTIME
TRIM_SPEC
A trim specification, for trimming and padding functions
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FunctionParameterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static FunctionParameterType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 typeSqlTypes.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 theextract()
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 thecollate()
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)
-
-
Method Detail
-
values
public static FunctionParameterType[] 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 (FunctionParameterType c : FunctionParameterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FunctionParameterType 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 nameNullPointerException
- if the argument is null
-
-