Package org.graylog.plugins.pipelineprocessor.ast.functions

Class FunctionDescriptor<T>

java.lang.Object

org.graylog.plugins.pipelineprocessor.ast.functions.FunctionDescriptor<T>

public abstract class FunctionDescriptor<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionDescriptor.Builder<T>

Constructor Summary

Constructors

Constructor	Description
FunctionDescriptor()

Method Summary

Modifier and Type	Method	Description
static <T> FunctionDescriptor.Builder<T>	builder()
static <T> FunctionDescriptor<T>	createForRuleBuilder(String name, Class<? extends T> returnType, com.google.common.collect.ImmutableList<ParameterDescriptor> params, String description, String ruleBuilderName, String ruleBuilderTitle, RuleBuilderFunctionGroup ruleBuilderFunctionGroup)
abstract String	description()
String	getRuleBuilderName()	default to function name
abstract String	name()
ParameterDescriptor	param(String name)
abstract com.google.common.collect.ImmutableMap<String,ParameterDescriptor>	paramMap()
abstract com.google.common.collect.ImmutableList<ParameterDescriptor>	params()
abstract boolean	pure()
abstract Class<? extends T>	returnType()
abstract boolean	ruleBuilderEnabled()
abstract RuleBuilderFunctionGroup	ruleBuilderFunctionGroup()
abstract String	ruleBuilderName()
abstract String	ruleBuilderTitle()

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionDescriptor

public FunctionDescriptor()

Method Details

name

public abstract String name()

pure

public abstract boolean pure()

returnType

public abstract Class<? extends T> returnType()

params

public abstract com.google.common.collect.ImmutableList<ParameterDescriptor> params()

paramMap

public abstract com.google.common.collect.ImmutableMap<String,ParameterDescriptor> paramMap()

param

public ParameterDescriptor param(String name)

description

@Nullable
public abstract String description()

ruleBuilderEnabled

public abstract boolean ruleBuilderEnabled()

ruleBuilderName

@Nullable
public abstract String ruleBuilderName()

getRuleBuilderName

public String getRuleBuilderName()

default to function name

Returns:

function name, if rule builder is enabled and no name is explicitly set

ruleBuilderTitle

@Nullable
public abstract String ruleBuilderTitle()

ruleBuilderFunctionGroup

@Nullable
public abstract RuleBuilderFunctionGroup ruleBuilderFunctionGroup()

builder

public static <T> FunctionDescriptor.Builder<T> builder()

createForRuleBuilder

public static <T> FunctionDescriptor<T> createForRuleBuilder(String name,
 Class<? extends T> returnType,
 @Nullable
 com.google.common.collect.ImmutableList<ParameterDescriptor> params,
 @Nullable
 String description,
 @Nullable
 String ruleBuilderName,
 @Nullable
 String ruleBuilderTitle,
 @Nullable
 RuleBuilderFunctionGroup ruleBuilderFunctionGroup)