Package ch.njol.skript.lang.function

Class Parameter<T>

java.lang.Object

ch.njol.skript.lang.function.Parameter<T>

public final class Parameter<T>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	PARAM_PATTERN

Constructor Summary

Constructors

Constructor	Description
Parameter(String name, ClassInfo<T> type, boolean single, @Nullable Expression<? extends T> def)

Method Summary

Modifier and Type	Method	Description
@Nullable Expression<? extends T>	getDefaultExpression()	Get the Expression that will be used to provide the default value of this parameter when the function is called.
String	getName()	Get the name of this parameter.
ClassInfo<T>	getType()	Get the Type of this parameter.
boolean	isSingleValue()	Get whether this parameter takes one or many values.
static <T> @Nullable Parameter<T>	newInstance(String name, ClassInfo<T> type, boolean single, @Nullable String def)
static @Nullable List<Parameter<?>>	parse(String args)	Parses function parameters from a string.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

PARAM_PATTERN

public static final Pattern PARAM_PATTERN

Constructor Details

Parameter

public Parameter(String name,
 ClassInfo<T> type,
 boolean single,
 @Nullable
 @Nullable Expression<? extends T> def)

Method Details

getType

public ClassInfo<T> getType()

Get the Type of this parameter.

Returns:

Type of the parameter

newInstance

@Nullable
public static <T> @Nullable Parameter<T> newInstance(String name,
 ClassInfo<T> type,
 boolean single,
 @Nullable
 @Nullable String def)

parse

@Nullable
public static @Nullable List<Parameter<?>> parse(String args)

Parses function parameters from a string. The string should look something like this:

"something: string, something else: number = 12"

Parameters:

args - The string to parse.

Returns:

The parsed parameters

getName

public String getName()

Get the name of this parameter.

Will be used as name for the local variable that contains value of it inside function.

Returns:

Name of this parameter

getDefaultExpression

@Nullable
public @Nullable Expression<? extends T> getDefaultExpression()

Get the Expression that will be used to provide the default value of this parameter when the function is called.

Returns:

Expression that will provide default value of this parameter

isSingleValue

public boolean isSingleValue()

Get whether this parameter takes one or many values.

Returns:

True if this parameter takes one value, false otherwise

toString

public String toString()

Overrides:

toString in class Object