org.graylog.plugins.pipelineprocessor.ast.functions

Class ParameterDescriptor<T,R>

java.lang.Object

org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor<T,R>

public abstract class ParameterDescriptor<T,R>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterDescriptor.Builder<T,R>

Constructor Summary

Constructors

Constructor and Description
ParameterDescriptor()

Method Summary

Modifier and Type	Method and Description
static ParameterDescriptor.Builder<Boolean,Boolean>	bool(String name)
static <R> ParameterDescriptor.Builder<Boolean,R>	bool(String name, Class<? extends R> transformedClass)
abstract String	description()
static ParameterDescriptor.Builder<Double,Double>	floating(String name)
static <R> ParameterDescriptor.Builder<Double,R>	floating(String name, Class<? extends R> transformedClass)
static ParameterDescriptor.Builder<Long,Long>	integer(String name)
static <R> ParameterDescriptor.Builder<Long,R>	integer(String name, Class<? extends R> transformedClass)
abstract String	name()
static ParameterDescriptor.Builder<Object,Object>	object(String name)
static <R> ParameterDescriptor.Builder<Object,R>	object(String name, Class<? extends R> transformedClass)
abstract boolean	optional()
Optional<R>	optional(FunctionArgs args, EvaluationContext context)
static <T,R> ParameterDescriptor.Builder<T,R>	param()
R	required(FunctionArgs args, EvaluationContext context)
static ParameterDescriptor.Builder<String,String>	string(String name)
static <R> ParameterDescriptor.Builder<String,R>	string(String name, Class<? extends R> transformedClass)
abstract Function<T,R>	transform()
abstract Class<? extends R>	transformedType()
abstract Class<? extends T>	type()
static <T> ParameterDescriptor.Builder<T,T>	type(String name, Class<? extends T> typeClass)
static <T,R> ParameterDescriptor.Builder<T,R>	type(String name, Class<? extends T> typeClass, Class<? extends R> transformedClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDescriptor

public ParameterDescriptor()

Method Detail

type

public abstract Class<? extends T> type()

transformedType

public abstract Class<? extends R> transformedType()

name

public abstract String name()

optional

public abstract boolean optional()

transform

public abstract Function<T,R> transform()

description

@Nullable
public abstract String description()

param

public static <T,R> ParameterDescriptor.Builder<T,R> param()

string

public static ParameterDescriptor.Builder<String,String> string(String name)

string

public static <R> ParameterDescriptor.Builder<String,R> string(String name,
                                                               Class<? extends R> transformedClass)

object

public static ParameterDescriptor.Builder<Object,Object> object(String name)

object

public static <R> ParameterDescriptor.Builder<Object,R> object(String name,
                                                               Class<? extends R> transformedClass)

integer

public static ParameterDescriptor.Builder<Long,Long> integer(String name)

integer

public static <R> ParameterDescriptor.Builder<Long,R> integer(String name,
                                                              Class<? extends R> transformedClass)

floating

public static ParameterDescriptor.Builder<Double,Double> floating(String name)

floating

public static <R> ParameterDescriptor.Builder<Double,R> floating(String name,
                                                                 Class<? extends R> transformedClass)

bool

public static ParameterDescriptor.Builder<Boolean,Boolean> bool(String name)

bool

public static <R> ParameterDescriptor.Builder<Boolean,R> bool(String name,
                                                              Class<? extends R> transformedClass)

type

public static <T> ParameterDescriptor.Builder<T,T> type(String name,
                                                        Class<? extends T> typeClass)

type

public static <T,R> ParameterDescriptor.Builder<T,R> type(String name,
                                                          Class<? extends T> typeClass,
                                                          Class<? extends R> transformedClass)

required

@Nullable
public R required(FunctionArgs args,
                            EvaluationContext context)

optional

public Optional<R> optional(FunctionArgs args,
                            EvaluationContext context)