Package se.kuseman.payloadbuilder.api.catalog

Class FunctionInfo

java.lang.Object

se.kuseman.payloadbuilder.api.catalog.FunctionInfo

Direct Known Subclasses:

OperatorFunctionInfo, ScalarFunctionInfo, TableFunctionInfo

public abstract class FunctionInfo
extends Object

Base class for functions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionInfo.Arity	Arity definition for functions
static enum	FunctionInfo.FunctionType	Function type

Constructor Summary

Constructors

Constructor	Description
FunctionInfo(String name, FunctionInfo.FunctionType type)

Method Summary

Modifier and Type	Method	Description
FunctionInfo.Arity	arity()	Return this functions arity.
boolean	equals(Object obj)
String	getDescription()	Description of function.
FunctionInfo.FunctionType	getFunctionType()
String	getName()
int	hashCode()
boolean	requiresNamedArguments()	Returns true if all arguments should be named for this function else false.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionInfo

public FunctionInfo(String name,
 FunctionInfo.FunctionType type)

Method Details

getName

public String getName()

getDescription

public String getDescription()

Description of function. Used in show statement for a description of the function.

getFunctionType

public FunctionInfo.FunctionType getFunctionType()

requiresNamedArguments

public boolean requiresNamedArguments()

Returns true if all arguments should be named for this function else false.

arity

public FunctionInfo.Arity arity()

Return this functions arity.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object