Package org.hibernate.dialect.function
Class NoArgSQLFunction
- java.lang.Object
-
- org.hibernate.dialect.function.NoArgSQLFunction
-
- All Implemented Interfaces:
SQLFunction
- Direct Known Subclasses:
StaticPrecisionFspTimestampFunction
public class NoArgSQLFunction extends java.lang.Object implements SQLFunction
A function which takes no arguments
-
-
Constructor Summary
Constructors Constructor Description NoArgSQLFunction(java.lang.String name, Type returnType)
Constructs a NoArgSQLFunctionNoArgSQLFunction(java.lang.String name, Type returnType, boolean hasParenthesesIfNoArguments)
Constructs a NoArgSQLFunction
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getName()
Type
getReturnType(Type argumentType, Mapping mapping)
The return type of the function.boolean
hasArguments()
Does this function have any arguments?boolean
hasParenthesesIfNoArguments()
If there are no arguments, are parentheses required?java.lang.String
render(Type argumentType, java.util.List args, SessionFactoryImplementor factory)
Render the function call as SQL fragment.
-
-
-
Constructor Detail
-
NoArgSQLFunction
public NoArgSQLFunction(java.lang.String name, Type returnType)
Constructs a NoArgSQLFunction- Parameters:
name
- The function namereturnType
- The function return type
-
NoArgSQLFunction
public NoArgSQLFunction(java.lang.String name, Type returnType, boolean hasParenthesesIfNoArguments)
Constructs a NoArgSQLFunction- Parameters:
name
- The function namereturnType
- The function return typehasParenthesesIfNoArguments
- Does the function call need parenthesis if there are no arguments?
-
-
Method Detail
-
hasArguments
public boolean hasArguments()
Description copied from interface:SQLFunction
Does this function have any arguments?- Specified by:
hasArguments
in interfaceSQLFunction
- Returns:
- True if the function expects to have parameters; false otherwise.
-
hasParenthesesIfNoArguments
public boolean hasParenthesesIfNoArguments()
Description copied from interface:SQLFunction
If there are no arguments, are parentheses required?- Specified by:
hasParenthesesIfNoArguments
in interfaceSQLFunction
- Returns:
- True if a no-arg call of this function requires parentheses.
-
getReturnType
public Type getReturnType(Type argumentType, Mapping mapping) throws QueryException
Description copied from interface:SQLFunction
The return type of the function. May be either a concrete type which is preset, or variable depending upon the type of the first function argument. Note, the 'firstArgumentType' parameter should match the one passed intoSQLFunction.render(org.hibernate.type.Type, java.util.List, org.hibernate.engine.spi.SessionFactoryImplementor)
- Specified by:
getReturnType
in interfaceSQLFunction
- Parameters:
argumentType
- The type of the first argumentmapping
- The mapping source.- Returns:
- The type to be expected as a return.
- Throws:
QueryException
- Indicates an issue resolving the return type.
-
render
public java.lang.String render(Type argumentType, java.util.List args, SessionFactoryImplementor factory) throws QueryException
Description copied from interface:SQLFunction
Render the function call as SQL fragment. Note, the 'firstArgumentType' parameter should match the one passed intoSQLFunction.getReturnType(org.hibernate.type.Type, org.hibernate.engine.spi.Mapping)
- Specified by:
render
in interfaceSQLFunction
- Parameters:
argumentType
- The type of the first argumentargs
- The function argumentsfactory
- The SessionFactory- Returns:
- The rendered function call
- Throws:
QueryException
- Indicates a problem rendering the function call.
-
getName
protected java.lang.String getName()
-
-