MOEA Framework 2.5
API Specification

org.moeaframework.util.tree
Class Call

java.lang.Object
  extended by org.moeaframework.util.tree.Node
      extended by org.moeaframework.util.tree.Call

public class Call
extends Node

The node for calling a named function.

See Also:
Define

Constructor Summary
Call(Define function)
          Constructs a new node for calling the function as defined.
Call(String functionName, Class<?> returnType)
          Constructs a new node for calling a function that takes no arguments.
Call(String functionName, Class<?> returnType, String[] variableNames, Class<?>[] variableTypes)
          Constructs a new node for calling a function that takes a user-defined number of arguments.
Call(String functionName, Class<?> returnType, String variableName, Class<?> variableType)
          Constructs a new node for calling a function that takes one argument.
Call(String functionName, Class<?> returnType, String name1, Class<?> type1, String name2, Class<?> type2)
          Constructs a new node for calling a function that takes two arguments.
 
Method Summary
 Node copyNode()
          Returns a copy of this node, but without any children or parents assigned.
 Object evaluate(Environment environment)
          Evaluates this node in the context of the specified environment.
 String getFunctionName()
          Returns the name of this function.
 String[] getVariableNames()
          Returns the names of the arguments to this function.
 Class<?>[] getVariableTypes()
          Returns the types of the arguments to this function.
 String toString()
          Returns a string representation of the object.
 
Methods inherited from class org.moeaframework.util.tree.Node
copyTree, getArgument, getArgumentType, getDepth, getFunctionAt, getFunctionAt, getMaximumHeight, getMinimumHeight, getNodeAt, getNodeAt, getNodeAt, getNumberOfArguments, getNumberOfFunctions, getNumberOfFunctions, getNumberOfNodes, getNumberOfNodes, getNumberOfNodes, getNumberOfTerminals, getNumberOfTerminals, getParent, getReturnType, getTerminalAt, getTerminalAt, isFixed, isTerminal, isValid, setArgument, setFixed, setFixedTree, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Call

public Call(String functionName,
            Class<?> returnType)
Constructs a new node for calling a function that takes no arguments.

Parameters:
functionName - the name of the function
returnType - the return type of the function

Call

public Call(String functionName,
            Class<?> returnType,
            String variableName,
            Class<?> variableType)
Constructs a new node for calling a function that takes one argument.

Parameters:
functionName - the name of the function
returnType - the return type of the function
variableName - the name of the argument
variableType - the type of the argument

Call

public Call(String functionName,
            Class<?> returnType,
            String name1,
            Class<?> type1,
            String name2,
            Class<?> type2)
Constructs a new node for calling a function that takes two arguments.

Parameters:
functionName - the name of the function
returnType - the return type of the function
name1 - the name of the first argument
type1 - the type of the first argument
name2 - the name of the second argument
type2 - the type of the second argument

Call

public Call(Define function)
Constructs a new node for calling the function as defined.

Parameters:
function - the function

Call

public Call(String functionName,
            Class<?> returnType,
            String[] variableNames,
            Class<?>[] variableTypes)
Constructs a new node for calling a function that takes a user-defined number of arguments.

Parameters:
functionName - the name of the function
returnType - the return type of the function
variableNames - the names of the arguments to the function
variableTypes - the types of the arguments to the function
Method Detail

getFunctionName

public String getFunctionName()
Returns the name of this function.

Returns:
the name of this function

getVariableNames

public String[] getVariableNames()
Returns the names of the arguments to this function.

Returns:
the names of the arguments to this function

getVariableTypes

public Class<?>[] getVariableTypes()
Returns the types of the arguments to this function.

Returns:
the types of the arguments to this function

copyNode

public Node copyNode()
Description copied from class: Node
Returns a copy of this node, but without any children or parents assigned.

Specified by:
copyNode in class Node
Returns:
a copy of this node, but without any children or parents assigned

evaluate

public Object evaluate(Environment environment)
Description copied from class: Node
Evaluates this node in the context of the specified environment.

Specified by:
evaluate in class Node
Parameters:
environment - the execution environment
Returns:
the result of evaluating this node

toString

public String toString()
Description copied from class: java.lang.Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:
toString in class Node
Returns:
a string representation of the object.

MOEA Framework 2.5
API Specification

Copyright 2009-2015 MOEA Framework. All rights reserved.
Licensed under the GNU Lesser General Public License.
Return to the MOEA Framework homepage. Hosted by Get MOEA Framework at SourceForge.net. Fast, secure and Free Open Source software downloads