org.oakgp.function

Class Signature

java.lang.Object

org.oakgp.function.Signature

public final class Signature
extends Object

Represents the type signature of a Function.

A signature includes the return type, the number of arguments and the type of each argument.

Method Summary

Modifier and Type	Method and Description
static Signature	createSignature(Type returnType, Type... argumentTypes) Returns a new Signature with the specified return type and argument types.
boolean	equals(Object o)
Type	getArgumentType(int index) Returns the Type at the specified position in the arguments of this signature.
List<Type>	getArgumentTypes() Returns an unmodifiable list containing the type of each argument associated with this signature.
int	getArgumentTypesLength() Returns the number of arguments in this signature.
Type	getReturnType() Returns the type associated with values returned by the evaluation of functions that have this signature.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createSignature

public static Signature createSignature(Type returnType,
                                        Type... argumentTypes)

Returns a new Signature with the specified return type and argument types.

getReturnType

public Type getReturnType()

Returns the type associated with values returned by the evaluation of functions that have this signature.

getArgumentType

public Type getArgumentType(int index)

Returns the Type at the specified position in the arguments of this signature.

Parameters:

index - index of the argument to return

Returns:

the Type at the specified position in the arguments of this signature.

Throws:

ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getArgumentTypesLength())

getArgumentTypesLength

public int getArgumentTypesLength()

Returns the number of arguments in this signature.

getArgumentTypes

public List<Type> getArgumentTypes()

Returns an unmodifiable list containing the type of each argument associated with this signature.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object