org.omegahat.Environment.Parser.Parse
Class List

java.lang.Object
  |
  +--antlr.BaseAST
        |
        +--antlr.CommonAST
              |
              +--org.omegahat.Environment.Parser.Parse.BasicExpression
                    |
                    +--org.omegahat.Environment.Parser.Parse.List
All Implemented Interfaces:
antlr.collections.AST, java.lang.Cloneable, Evaluable, ExpressionInt, OmegaTokenTypes, java.lang.Runnable, java.io.Serializable, Subsettable, TreeNodeInt
Direct Known Subclasses:
ArgList, ArrayDimensionExpression, ClassList, FunctionCallArguments, InteractionTerm, ListGradient, MultiLineModelFormula, Name, StatementList, SwitchCase

public class List
extends BasicExpression
implements ExpressionInt, java.lang.Cloneable, Subsettable

A basic vector-like list for storing objects, used in numerous places in the parser, such as method call arguments, collections of statements, etc.

See Also:
Serialized Form

Field Summary
protected  java.util.Vector elements
           
protected  java.lang.String separator
           
 
Fields inherited from class org.omegahat.Environment.Parser.Parse.BasicExpression
children, comments, isActive, parent, POST, PRE
 
Fields inherited from class antlr.BaseAST
down, right
 
Fields inherited from interface org.omegahat.Environment.Parser.AntlrParser.OmegaTokenTypes
ABSTRACT, ARG_LIST, ARRAY_DECLARATOR, ARRAY_INIT, ASSIGN, BAND, BAND_ASSIGN, BLOCK, BNOT, BOR, BOR_ASSIGN, BREAK, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, CHAR_LITERAL, CLASS_DEF, COLON, COMMA, CONTINUE, CTOR_DEF, DEC, DIV, DIV_ASSIGN, DOT, DOTS, EAGER, ELEMENT_OP, EOF, EQUAL, ESC, EXPONENT, EXPONENT_OP, EXPR, EXTENDS_CLAUSE, FINAL, FLOAT_SUFFIX, FUNCTION, GE, GT, HEX_DIGIT, IDENT, IMPLEMENTS_CLAUSE, IMPORT, INC, INDEX_OP, INSTANCE_INIT, INSTANCEOF, INTERFACE_DEF, LABELED_STAT, LAND, LAZY, LBRACK, LCURLY, LE, LITERAL_abstract, LITERAL_boolean, LITERAL_break, LITERAL_byte, LITERAL_case, LITERAL_catch, LITERAL_char, LITERAL_class, LITERAL_const, LITERAL_continue, LITERAL_default, LITERAL_do, LITERAL_double, LITERAL_eager, LITERAL_else, LITERAL_extends, LITERAL_false, LITERAL_final, LITERAL_finally, LITERAL_float, LITERAL_for, LITERAL_function, LITERAL_global, LITERAL_if, LITERAL_implements, LITERAL_import, LITERAL_in, LITERAL_instanceof, LITERAL_int, LITERAL_interface, LITERAL_lazy, LITERAL_long, LITERAL_method, LITERAL_native, LITERAL_new, LITERAL_null, LITERAL_private, LITERAL_protected, LITERAL_public, LITERAL_return, LITERAL_short, LITERAL_static, LITERAL_super, LITERAL_switch, LITERAL_synchronized, LITERAL_this, LITERAL_threadsafe, LITERAL_throw, LITERAL_throws, LITERAL_transient, LITERAL_true, LITERAL_try, LITERAL_void, LITERAL_while, LNOT, LOR, LPAREN, LT, METHOD, METHOD_CALL, METHOD_DEF, MINUS, MINUS_ASSIGN, MISSING_ARG, ML_COMMENT, MOD, MOD_ASSIGN, MODIFIERS, NOT_EQUAL, NULL_TREE_LOOKAHEAD, NUM_FLOAT, NUM_INT, NUM_LONG, OBJBLOCK, PACKAGE_DEF, PARAMETER_DEF, PARAMETERS, PLUS, PLUS_ASSIGN, POST_DEC, POST_INC, QUESTION, RBRACK, RCURLY, RETURN, RPAREN, SEMI, SEQUENCE_OP, SL, SL_ASSIGN, SL_COMMENT, SLIST, SR, SR_ASSIGN, STAR, STAR_ASSIGN, STATIC_INIT, STRING_LITERAL, SYNCHRONIZED, THROW, TRANSIENT, TYPE, TYPECAST, UNARY_MINUS, UNARY_PLUS, VARIABLE_DEF, VOCAB, WS
 
Constructor Summary
List()
           
List(antlr.collections.AST tree)
           
List(antlr.collections.AST tree, boolean down)
           
List(int len)
           
List(List l)
           
List(java.lang.Object el)
           
List(java.lang.Object[] els)
           
 
Method Summary
 void addElement(java.lang.Object o)
           
 int addElements(antlr.collections.AST tree)
           
 int addElements(antlr.collections.AST tree, boolean down)
           
 int addElements(List l)
           
 java.lang.Object addResult(java.lang.Object o, int which, java.lang.Object value)
           
 java.lang.String asString()
           
 java.lang.String asString(boolean val)
           
 java.lang.String asString(boolean finalSeparator, java.lang.String sep)
           
 void clear()
           
 java.lang.Object clone()
           
 boolean contains(java.lang.Object o)
           
 void copyElements(List n)
           
 java.lang.Object elementAt(int which)
           
 java.util.Enumeration elements()
           
 void elementToString(java.lang.Object o, boolean showSeparator, java.lang.StringBuffer buf)
           
 java.lang.Object eval(Evaluator evaluator)
          Evaluate this object by evaluating each of its elements, where possible.
 java.lang.Object eval(Evaluator evaluator, boolean keepNames)
          Evaluate this object by evaluating each of its elements, where possible.
 java.lang.Object evalElement(java.lang.Object o, int which, Evaluator evaluator)
           
 java.lang.Object evalElement(java.lang.Object o, int which, java.lang.Object value, Evaluator evaluator)
          Evaluate the individual element in the List.
protected  java.lang.Object evalResult(Evaluator evaluator)
           
 antlr.collections.AST getFirstChild()
           
 java.util.AbstractCollection getReferencedVariables(boolean recursive, java.util.AbstractCollection container)
           
 java.lang.Object lastElement()
           
 TreeNodeInt parent(TreeNodeInt p)
           
 java.lang.String separator()
           
 java.lang.String separator(java.lang.String el)
           
 java.lang.Object setElementAt(java.lang.Object o, int which)
           
 int size()
           
 int size(int len)
           
 List subset(int which)
           
 List subset(int[] which)
           
 java.lang.Object subset(java.lang.Object index, boolean keepStructure)
           
 java.lang.Object[] toArray()
           
 java.lang.String toString()
           
 java.lang.String toString(boolean finalSeparator)
           
 
Methods inherited from class org.omegahat.Environment.Parser.Parse.BasicExpression
addChild, addComment, apply, apply, apply, children, children, comment, comment, depth, error, eval, evalInit, evaluationFrame, evaluator, getReferencedVariables, getReferencedVariables, isActive, isActive, parent, postComment, postComment, preComment, preComment, render, replaceChild, resolve, run, setParent, setParent, setParent, setParent, showComments, showComments, substitute, substitute
 
Methods inherited from class antlr.CommonAST
getText, getType, initialize, initialize, initialize, setText, setType
 
Methods inherited from class antlr.BaseAST
addChild, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getNextSibling, removeChildren, setFirstChild, setNextSibling, setVerboseStringConversion, toStringList, toStringTree
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.omegahat.Environment.Parser.Parse.ExpressionInt
error, resolve, substitute
 
Methods inherited from interface org.omegahat.Environment.Parser.Parse.TreeNodeInt
addChild, children, depth, parent, replaceChild
 
Methods inherited from interface org.omegahat.Environment.Language.Evaluable
eval
 

Field Detail

separator

protected java.lang.String separator

elements

protected java.util.Vector elements
Constructor Detail

List

public List(int len)

List

public List()

List

public List(java.lang.Object el)

List

public List(List l)

List

public List(java.lang.Object[] els)

List

public List(antlr.collections.AST tree)

List

public List(antlr.collections.AST tree,
            boolean down)
Method Detail

eval

public java.lang.Object eval(Evaluator evaluator)
                      throws java.lang.Throwable
Evaluate this object by evaluating each of its elements, where possible.
Specified by:
eval in interface Evaluable
Overrides:
eval in class BasicExpression

eval

public java.lang.Object eval(Evaluator evaluator,
                             boolean keepNames)
                      throws java.lang.Throwable
Evaluate this object by evaluating each of its elements, where possible.

addResult

public java.lang.Object addResult(java.lang.Object o,
                                  int which,
                                  java.lang.Object value)

evalElement

public java.lang.Object evalElement(java.lang.Object o,
                                    int which,
                                    java.lang.Object value,
                                    Evaluator evaluator)
                             throws java.lang.Throwable
Evaluate the individual element in the List. This is called from the general eval() method for the List object. The second argument is potentially the return value from the overall evaluation of the container object and contains the previously evaluated elements.

evalElement

public java.lang.Object evalElement(java.lang.Object o,
                                    int which,
                                    Evaluator evaluator)
                             throws java.lang.Throwable

toString

public java.lang.String toString()
Overrides:
toString in class BasicExpression

toString

public java.lang.String toString(boolean finalSeparator)

asString

public java.lang.String asString()

asString

public java.lang.String asString(boolean val)

asString

public java.lang.String asString(boolean finalSeparator,
                                 java.lang.String sep)

elementToString

public void elementToString(java.lang.Object o,
                            boolean showSeparator,
                            java.lang.StringBuffer buf)

separator

public java.lang.String separator()

separator

public java.lang.String separator(java.lang.String el)

size

public int size(int len)

size

public int size()

addElement

public void addElement(java.lang.Object o)

elements

public java.util.Enumeration elements()

elementAt

public java.lang.Object elementAt(int which)

contains

public boolean contains(java.lang.Object o)

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

copyElements

public void copyElements(List n)

clear

public void clear()

setElementAt

public java.lang.Object setElementAt(java.lang.Object o,
                                     int which)

evalResult

protected java.lang.Object evalResult(Evaluator evaluator)

toArray

public java.lang.Object[] toArray()

subset

public List subset(int which)

subset

public List subset(int[] which)

subset

public java.lang.Object subset(java.lang.Object index,
                               boolean keepStructure)
                        throws java.lang.Throwable
Specified by:
subset in interface Subsettable
Overrides:
subset in class BasicExpression

lastElement

public java.lang.Object lastElement()

addElements

public int addElements(antlr.collections.AST tree)

addElements

public int addElements(antlr.collections.AST tree,
                       boolean down)

addElements

public int addElements(List l)

getFirstChild

public antlr.collections.AST getFirstChild()
Overrides:
getFirstChild in class antlr.BaseAST

getReferencedVariables

public java.util.AbstractCollection getReferencedVariables(boolean recursive,
                                                           java.util.AbstractCollection container)
Overrides:
getReferencedVariables in class BasicExpression

parent

public TreeNodeInt parent(TreeNodeInt p)
Specified by:
parent in interface TreeNodeInt
Overrides:
parent in class BasicExpression