Top Description Fields Constructors Methods
org.h2.mode

public final Class FunctionInfo

extends Object
Class Inheritance

This class contains information about a built-in function.

Field Summary

Modifier and TypeField and Description
public final boolean
deterministic

If this function always returns the same value for the same parameters.

public final String
name

The name of the function.

public final boolean
nullIfParameterIsNull

If the result of the function is NULL if any of the parameters is NULL.

pack-priv final int
parameterCount

The number of parameters.

public final int
returnDataType

The data type of the return value.

public final int
type

The function type.

Constructor Summary

AccessConstructor and Description
public
FunctionInfo(String
the name of the function
name
,
int
the function type
type
,
int
the number of parameters
parameterCount
,
int
the data type of the return value
returnDataType
,
boolean
if the result of the function is NULL if any of the parameters is NULL
nullIfParameterIsNull
,
boolean
if this function always returns the same value for the same parameters
deterministic
)

Creates new instance of built-in function information.

public
FunctionInfo(FunctionInfo
the source information
source
,
String
the new name
name
)

Creates a copy of built-in function information with a different name.

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

deterministicback to summary
public final boolean deterministic

If this function always returns the same value for the same parameters.

nameback to summary
public final String name

The name of the function.

nullIfParameterIsNullback to summary
public final boolean nullIfParameterIsNull

If the result of the function is NULL if any of the parameters is NULL.

parameterCountback to summary
pack-priv final int parameterCount

The number of parameters.

returnDataTypeback to summary
public final int returnDataType

The data type of the return value.

typeback to summary
public final int type

The function type.

Constructor Detail

FunctionInfoback to summary
public FunctionInfo(String name, int type, int parameterCount, int returnDataType, boolean nullIfParameterIsNull, boolean deterministic)

Creates new instance of built-in function information.

Parameters
name:String

the name of the function

type:int

the function type

parameterCount:int

the number of parameters

returnDataType:int

the data type of the return value

nullIfParameterIsNull:boolean

if the result of the function is NULL if any of the parameters is NULL

deterministic:boolean

if this function always returns the same value for the same parameters

FunctionInfoback to summary
public FunctionInfo(FunctionInfo source, String name)

Creates a copy of built-in function information with a different name. A copy will require parentheses.

Parameters
source:FunctionInfo

the source information

name:String

the new name