Package ch.njol.skript.lang.function

Class Signature<T>

java.lang.Object

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

All Implemented Interfaces:

Signature<T>

public class Signature<T>
extends Object
implements Signature<T>

Function signature: name, parameter types and a return type.

Constructor Summary

Constructors

Constructor	Description
Signature(@Nullable String script, String name, Parameter<?>[] parameters, boolean local, @Nullable ClassInfo<T> returnType, boolean single, @Nullable String originClassPath, @Nullable Contract contract)
Signature(@Nullable String script, String name, Parameter<?>[] parameters, @Nullable Class<T> returnType, boolean single, @Nullable Contract contract)	Creates a new signature.
Signature(String script, String name, Parameter<?>[] parameters, boolean local, @Nullable ClassInfo<T> returnType, boolean single)
Signature(String script, String name, Parameter<?>[] parameters, boolean local, @Nullable ClassInfo<T> returnType, boolean single, @Nullable String originClassPath)

Method Summary

Modifier and Type	Method	Description
@Nullable Contract	getContract()
int	getMaxParameters()	Gets maximum number of parameters that the function described by this signature is able to take.
int	getMinParameters()	Gets minimum number of parameters that the function described by this signature is able to take.
String	getName()
String	getOriginClassPath()	Deprecated, for removal: This API element is subject to removal in a future version. Unused and unsafe.
Parameter<?>	getParameter(int index)
Parameter<?>[]	getParameters()
@Nullable ClassInfo<T>	getReturnType()
int	hashCode()
boolean	isLocal()
boolean	isSingle()
String	toString()
String	toString(boolean includeReturnType, boolean debug)

Methods inherited from class java.lang.Object

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

Constructor Details

Signature

public Signature(@Nullable
 @Nullable String script,
 String name,
 Parameter<?>[] parameters,
 boolean local,
 @Nullable
 @Nullable ClassInfo<T> returnType,
 boolean single,
 @Nullable
 @Nullable String originClassPath,
 @Nullable
 @Nullable Contract contract)

Signature

public Signature(@Nullable
 @Nullable String script,
 String name,
 Parameter<?>[] parameters,
 @Nullable
 @Nullable Class<T> returnType,
 boolean single,
 @Nullable
 @Nullable Contract contract)

Creates a new signature.

Parameters:

script - The script of this signature.

name - The name of the function.

parameters - The parameters.

returnType - The return type class.

contract - A Contract that may belong to this signature.

Signature

public Signature(String script,
 String name,
 Parameter<?>[] parameters,
 boolean local,
 @Nullable
 @Nullable ClassInfo<T> returnType,
 boolean single,
 @Nullable
 @Nullable String originClassPath)

Signature

public Signature(String script,
 String name,
 Parameter<?>[] parameters,
 boolean local,
 @Nullable
 @Nullable ClassInfo<T> returnType,
 boolean single)

Method Details

getName

public String getName()

getParameter

public Parameter<?> getParameter(int index)

getParameters

public Parameter<?>[] getParameters()

isLocal

public boolean isLocal()

getReturnType

@Nullable
public @Nullable ClassInfo<T> getReturnType()

isSingle

public boolean isSingle()

getOriginClassPath

@Deprecated(forRemoval=true,
            since="2.13")
public String getOriginClassPath()

Deprecated, for removal: This API element is subject to removal in a future version.

Unused and unsafe.

getContract

@Nullable
public @Nullable Contract getContract()

getMaxParameters

public int getMaxParameters()

Gets maximum number of parameters that the function described by this signature is able to take.

Returns:

Maximum number of parameters.

getMinParameters

public int getMinParameters()

Gets minimum number of parameters that the function described by this signature is able to take. Parameters that have default values and do not have any parameters that are mandatory after them, are optional.

Returns:

Minimum number of parameters required.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean includeReturnType,
 boolean debug)