org.oakgp

Class Arguments

java.lang.Object

org.oakgp.Arguments

public final class Arguments
extends Object

Represents the arguments of a function.

Immutable.

Method Summary

Modifier and Type	Method and Description
static Arguments	createArguments(List<? extends Node> args) Returns a new Arguments which contains the specified values.
static Arguments	createArguments(Node... args) Returns a new Arguments which contains the specified values.
boolean	equals(Object o)
Node	firstArg() Returns the first argument in this Arguments.
Node	getArg(int index) Returns the Node at the specified position in this Arguments.
int	getArgCount() Returns the number of elements in this Arguments.
int	hashCode()
Arguments	replaceAt(int index, Node replacement) Returns a new Arguments resulting from replacing the existing Node at position index with replacement.
Node	secondArg() Returns the second argument in this Arguments.
Arguments	swap(int index1, int index2) Returns a new Arguments resulting from switching the node located at index index1 with the node located at index index2.
Node	thirdArg() Returns the third argument in this Arguments.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createArguments

public static Arguments createArguments(List<? extends Node> args)

Returns a new Arguments which contains the specified values.

Note: Arguments is immutable - so subsequent changes to args will not be reflected in the returned Arguments.

Parameters:

args - the values to be stored in the Arguments

Returns:

a new Arguments which contains the values specified by args

createArguments

public static Arguments createArguments(Node... args)

Returns a new Arguments which contains the specified values.

Note: Arguments is immutable - so subsequent changes to args will not be reflected in the returned Arguments.

Parameters:

args - the values to be stored in the Arguments

Returns:

a new Arguments which contains the values specified by args

getArg

public Node getArg(int index)

Returns the Node at the specified position in this Arguments.

Parameters:

index - index of the element to return

Returns:

the Node at the specified position in this Arguments

Throws:

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

firstArg

public Node firstArg()

Returns the first argument in this Arguments.

secondArg

public Node secondArg()

Returns the second argument in this Arguments.

thirdArg

public Node thirdArg()

Returns the third argument in this Arguments.

getArgCount

public int getArgCount()

Returns the number of elements in this Arguments.

Returns:

the number of elements in this Arguments

replaceAt

public Arguments replaceAt(int index,
                           Node replacement)

Returns a new Arguments resulting from replacing the existing Node at position index with replacement.

Parameters:

index - the index of the Node that needs to be replaced.

replacement - the new Node that needs to be store.

Returns:

A new Arguments derived from this Arguments by replacing the element at position index with replacement.

swap

public Arguments swap(int index1,
                      int index2)

Returns a new Arguments resulting from switching the node located at index index1 with the node located at index index2.

Parameters:

index1 - the index in this Arguments of the first Node to be swapped.

index2 - the index in this Arguments of the second Node to be swapped.

Returns:

A new Arguments resulting from switching the node located at index index1 with the node located at index index2.

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