Package org.skriptlang.skript.common.function

Interface Parameter<T>

Type Parameters:

T - The type of the function parameter.

All Known Implementing Classes:

Parameter

public interface Parameter<T>

Represents a function parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Parameter.Modifier	Represents a modifier that can be applied to a parameter when constructing one using DefaultFunction.Builder.parameter(String, Class, Modifier[])}.

Method Summary

Modifier and Type	Method	Description
default boolean	hasModifier(Parameter.Modifier modifier)	Returns whether this parameter has the specified modifier.
@Unmodifiable @NotNull Set<Parameter.Modifier>	modifiers()
@NotNull String	name()
default boolean	single()
@NotNull Class<T>	type()

Method Details

name

@NotNull
@NotNull String name()

Returns:

The name of this parameter.

type

@NotNull
@NotNull Class<T> type()

Returns:

The type of this parameter.

modifiers

@NotNull
@Unmodifiable @NotNull Set<Parameter.Modifier> modifiers()

Returns:

All modifiers belonging to this parameter.

hasModifier

default boolean hasModifier(Parameter.Modifier modifier)

Returns whether this parameter has the specified modifier.

Parameters:

modifier - The modifier.

Returns:

True when modifiers() contains the specified modifier, false if not.

single

default boolean single()

Returns:

Whether this parameter is for single values.