Package org.apache.gravitino.dto.function

Class FunctionParamDTO

java.lang.Object

org.apache.gravitino.dto.function.FunctionParamDTO

All Implemented Interfaces:

FunctionParam

public class FunctionParamDTO
extends Object
implements FunctionParam

DTO for function parameter.

Constructor Summary

Constructors

Constructor	Description
FunctionParamDTO()

Method Summary

Modifier and Type	Method	Description
String	comment()
Type	dataType()
Expression	defaultValue()
static FunctionParamDTO	fromFunctionParam(FunctionParam param)	Create a FunctionParamDTO from a FunctionParam instance.
String	name()
FunctionParam	toFunctionParam()	Convert this DTO to a FunctionParam instance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionParamDTO

public FunctionParamDTO()

Method Details

name

public String name()

Specified by:

name in interface FunctionParam

Returns:

The name of the parameter.

dataType

public Type dataType()

Specified by:

dataType in interface FunctionParam

Returns:

The data type of the parameter.

comment

public String comment()

Specified by:

comment in interface FunctionParam

Returns:

The optional comment of the parameter, null if not provided.

defaultValue

public Expression defaultValue()

Specified by:

defaultValue in interface FunctionParam

Returns:

The default value of the parameter if provided, otherwise Column.DEFAULT_VALUE_NOT_SET.

toFunctionParam

public FunctionParam toFunctionParam()

Convert this DTO to a FunctionParam instance.

Returns:

The function parameter.

fromFunctionParam

public static FunctionParamDTO fromFunctionParam(FunctionParam param)

Create a FunctionParamDTO from a FunctionParam instance.

Parameters:

param - The function parameter.

Returns:

The function parameter DTO.

toString

public String toString()

Overrides:

toString in class Object