org.h2.expression.function

Class FunctionInfo

java.lang.Object

org.h2.expression.function.FunctionInfo

public final class FunctionInfo
extends java.lang.Object

This class contains information about a built-in function.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	deterministic If this function always returns the same value for the same parameters.
java.lang.String	name The name of the function.
int	returnDataType The data type of the return value.
int	type The function type.

Constructor Summary

Constructors

Constructor and Description
FunctionInfo(FunctionInfo source, java.lang.String name) Creates a copy of built-in function information with a different name.
FunctionInfo(java.lang.String name, int type, int parameterCount, int returnDataType, boolean nullIfParameterIsNull, boolean deterministic, boolean requireParentheses, boolean specialArguments) Creates new instance of built-in function information.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public final java.lang.String name

The name of the function.

type

public final int type

The function type.

returnDataType

public final int returnDataType

The data type of the return value.

deterministic

public final boolean deterministic

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

Constructor Detail

FunctionInfo

public FunctionInfo(java.lang.String name,
            int type,
            int parameterCount,
            int returnDataType,
            boolean nullIfParameterIsNull,
            boolean deterministic,
            boolean requireParentheses,
            boolean specialArguments)

Creates new instance of built-in function information.

Parameters:

name - the name of the function

type - the function type

parameterCount - the number of parameters

returnDataType - the data type of the return value

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

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

requireParentheses - should the no-arg function require parentheses

specialArguments - if arguments cannot be evaluated in normal way with Expression.getValue(org.h2.engine.Session).

FunctionInfo

public FunctionInfo(FunctionInfo source,
            java.lang.String name)

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

Parameters:

source - the source information

name - the new name