bsh

Interface Node

All Superinterfaces:

java.util.Iterator<Node>, java.util.ListIterator<Node>

All Known Implementing Classes:

BSHAutoCloseable, BSHEnumConstant, BSHLabeledStatement, BSHLiteral, BSHMultiCatch, BSHPackageDeclaration, BSHTryWithResources, SimpleNode

public interface Node
extends java.util.ListIterator<Node>

Field Summary

Fields

Modifier and Type	Field and Description
static Node	JAVACODE

Method Summary

Modifier and Type	Method and Description
void	dump(java.lang.String prefix) Dump the children hierarchy.
java.lang.Object	eval(CallStack callstack, Interpreter interpreter) This is the general signature for evaluation of a node.
int	getId() Return the node type ID.
int	getLineNumber() Get the line number of the starting token
java.lang.String	getSourceFile() Get the name of the source file (or more generally source) of the text from which this node was parsed.
java.lang.String	getText() Get the text of the tokens comprising this node.
void	jjtAddChild(Node n, int i) Add argument to the list of children.
void	jjtClose() Called after all the child nodes have been added.
Node	jjtGetChild(int i) Returns the child node at the given index.
Node[]	jjtGetChildren() Return the list of child nodes..
int	jjtGetNumChildren() Return the number of children the node has.
Node	jjtGetParent() Return node parent.
void	jjtOpen() Called after the node has been made the current node.
void	jjtSetParent(Node n) Inform the node of its parent.
void	setSourceFile(java.lang.String sourceFile) Set the name of the source file (or more generally source) of the text from which this node was parsed.
java.lang.String	toString(java.lang.String prefix) Overloaded toString with prefix used by dump.

Methods inherited from interface java.util.ListIterator

add, hasNext, hasPrevious, next, nextIndex, previous, previousIndex, remove, set

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

JAVACODE

static final Node JAVACODE

Method Detail

eval

java.lang.Object eval(CallStack callstack,
                      Interpreter interpreter)
               throws EvalError

This is the general signature for evaluation of a node.

Parameters:

callstack - evaluation call stack

interpreter - evaluation interpreter

Returns:

result from evaluation

Throws:

EvalError - if an evaluation error occurred

setSourceFile

void setSourceFile(java.lang.String sourceFile)

Set the name of the source file (or more generally source) of the text from which this node was parsed.

Parameters:

sourceFile - source

getSourceFile

java.lang.String getSourceFile()

Get the name of the source file (or more generally source) of the text from which this node was parsed.

Returns:

source or parent's source or if no source found

getLineNumber

int getLineNumber()

Get the line number of the starting token

Returns:

line number

getText

java.lang.String getText()

Get the text of the tokens comprising this node.

Returns:

token text

dump

void dump(java.lang.String prefix)

Dump the children hierarchy.

Parameters:

prefix - a prefix string

toString

java.lang.String toString(java.lang.String prefix)

Overloaded toString with prefix used by dump.

Parameters:

prefix - a prefix string

Returns:

toString with prefix

jjtGetChildren

Node[] jjtGetChildren()

Return the list of child nodes..

Returns:

children array or zero length Node array

jjtOpen

void jjtOpen()

Called after the node has been made the current node. Indicates that child nodes can now be added to it.

jjtClose

void jjtClose()

Called after all the child nodes have been added.

jjtSetParent

void jjtSetParent(Node n)

Inform the node of its parent.

Parameters:

n -

jjtGetParent

Node jjtGetParent()

Return node parent.

Returns:

parent node

jjtAddChild

void jjtAddChild(Node n,
                 int i)

Add argument to the list of children.

Parameters:

n - the child node to add

i - index of child node

jjtGetChild

Node jjtGetChild(int i)

Returns the child node at the given index. The children are numbered from zero, left to right.

Parameters:

i - child index

Returns:

the node at index

jjtGetNumChildren

int jjtGetNumChildren()

Return the number of children the node has.

getId

int getId()

Return the node type ID.