Package org.skriptlang.skript.common.function

Class Parameters

java.lang.Object

org.skriptlang.skript.common.function.Parameters

public final class Parameters
extends Object

Holding class for a parameters of a function.

Constructor Summary

Constructors

Constructor	Description
Parameters(SequencedMap<String,Parameter<?>> parameters)

Method Summary

Modifier and Type	Method	Description
Parameter<?>[]	all()
Parameter<?>	get(int index)	Gets a parameter by index.
Parameter<?>	get(@NotNull String name)	Gets a parameter by name.
Parameter<?>	getFirst()
@UnmodifiableView SequencedMap<String,Parameter<?>>	sequencedMap()
int	size()

Methods inherited from class java.lang.Object

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

Constructor Details

Parameters

public Parameters(SequencedMap<String,Parameter<?>> parameters)

Method Details

get

public Parameter<?> get(@NotNull
 @NotNull String name)

Gets a parameter by name.

Parameters:

name - The name.

Returns:

The parameter, if present.

getFirst

public Parameter<?> getFirst()

Returns:

The first parameter, if present.

get

public Parameter<?> get(int index)

Gets a parameter by index.

Parameters:

index - The index.

Returns:

The parameter, if present.

all

public Parameter<?>[] all()

Returns:

An array of all parameters.

size

public int size()

Returns:

The amount of parameters.

sequencedMap

public @UnmodifiableView SequencedMap<String,Parameter<?>> sequencedMap()

Returns:

A copy of the backing sequenced map.