CSTNode (groovy 2.3.0-rc-1 API)

org.codehaus.groovy.syntax.CSTNode

An abstract base class for nodes in the concrete syntax tree that is the result of parsing. Note that the CSTNode is inextricably linked with the Token in that every CSTNode has a Token as it's root.
Authors:
bob mcwhirter
Chris Poirier
Version:
\$Id\$
See Also:
Parser
Token
Reduction
Types

Methods Summary

Methods
Type	Name and description
`CSTNode`	`add(CSTNode element)` Adds an element to the node.
`void`	`addChildrenOf(CSTNode of)`
`Reduction`	`asReduction()`
`boolean`	`canMean(int type)` Returns true if the node can be coerced to the specified type.
`int`	`children()` Returns the number of non-root elements in the node.
`CSTNode`	`get(int index)` Returns the specified element, or null.
`CSTNode`	`get(int index, boolean safe)`
`String`	`getDescription()` Returns a description of the node.
`int`	`getMeaning()` Returns the meaning of this node.
`int`	`getMeaningAs(int[] types)` Returns the first matching meaning of the specified types.
`Token`	`getRoot()` Returns the root of the node.
`Token`	`getRoot(boolean safe)`
`String`	`getRootText()` Returns the text of the root.
`int`	`getStartColumn()` Returns the starting column of the node.
`int`	`getStartLine()` Returns the starting line of the node.
`int`	`getType()` Returns the actual type of the node.
`boolean`	`hasChildren()`
`boolean`	`isA(int type)` Returns true if the node's meaning matches the specified type.
`boolean`	`isAllOf(int[] types)` Returns true if the node's meaning matches all of the specified types.
`boolean`	`isAnExpression()` Returns true if the node is a complete expression.
`boolean`	`isEmpty()` Returns true if the node is completely empty (no root, even).
`boolean`	`isOneOf(int[] types)` Returns true if the node's meaning matches any of the specified types.
`void`	`markAsExpression()` Marks the node a complete expression.
`CSTNode`	`set(int index, CSTNode element)` Sets an element node in at the specified index.
`CSTNode`	`setMeaning(int meaning)` Sets the meaning for this node (and it's root Token).
`int`	`size()` Returns the number of elements in the node (including root).
`String`	`toString()` Formats the node as a `String` and returns it.
`void`	`write(PrintWriter writer)`
`protected void`	`write(PrintWriter writer, String indent)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - public CSTNode add(CSTNode element)
    
    Adds an element to the node. Returns the element for convenience. Not all nodes support this operation!
  - public void addChildrenOf(CSTNode of)
  - public Reduction asReduction()
  - public boolean canMean(int type)
    
    Returns true if the node can be coerced to the specified type.
  - public int children()
    
    Returns the number of non-root elements in the node.
  - public CSTNode get(int index)
    
    Returns the specified element, or null.
  - public CSTNode get(int index, boolean safe)
  - public String getDescription()
    
    Returns a description of the node.
  - public int getMeaning()
    
    Returns the meaning of this node. If the node isEmpty(), returns the type of Token.NULL.
  - public int getMeaningAs(int[] types)
    
    Returns the first matching meaning of the specified types. Returns Types.UNKNOWN if there are no matches.
  - public Token getRoot()
    
    Returns the root of the node. By convention, all nodes have a Token as the first element (or root), which indicates the type of the node. May return null if the node isEmpty().
  - public Token getRoot(boolean safe)
  - public String getRootText()
    
    Returns the text of the root. Uses getRoot(true) to get the root, so you will only receive null in return if the root token returns it.
  - public int getStartColumn()
    
    Returns the starting column of the node. Returns -1 if not known.
  - public int getStartLine()
    
    Returns the starting line of the node. Returns -1 if not known.
  - public int getType()
    
    Returns the actual type of the node. If the node isEmpty(), returns the type of Token.NULL.
  - public boolean hasChildren()
  - public boolean isA(int type)
    
    Returns true if the node's meaning matches the specified type.
  - public boolean isAllOf(int[] types)
    
    Returns true if the node's meaning matches all of the specified types.
  - public boolean isAnExpression()
    
    Returns true if the node is a complete expression.
  - public boolean isEmpty()
    
    Returns true if the node is completely empty (no root, even).
  - public boolean isOneOf(int[] types)
    
    Returns true if the node's meaning matches any of the specified types.
  - public void markAsExpression()
    
    Marks the node a complete expression. Not all nodes support this operation!
  - public CSTNode set(int index, CSTNode element)
    
    Sets an element node in at the specified index. Returns the element for convenience. Not all nodes support this operation!
  - public CSTNode setMeaning(int meaning)
    
    Sets the meaning for this node (and it's root Token). Not valid if the node isEmpty(). Returns the node, for convenience.
  - public int size()
    
    Returns the number of elements in the node (including root).
  - public String toString()
    
    Formats the node as a String and returns it.
  - public void write(PrintWriter writer)
  - protected void write(PrintWriter writer, String indent)

Summary:
Method

| Detail:
Method

[Java] Class CSTNode

Methods Summary

Inherited Methods Summary

Method Detail

public CSTNode add(CSTNode element)

public void addChildrenOf(CSTNode of)

public Reduction asReduction()

public boolean canMean(int type)

public int children()

public CSTNode get(int index)

public CSTNode get(int index, boolean safe)

public String getDescription()

public int getMeaning()

public int getMeaningAs(int[] types)

public Token getRoot()

public Token getRoot(boolean safe)

public String getRootText()

public int getStartColumn()

public int getStartLine()

public int getType()

public boolean hasChildren()

public boolean isA(int type)

public boolean isAllOf(int[] types)

public boolean isAnExpression()

public boolean isEmpty()

public boolean isOneOf(int[] types)

public void markAsExpression()

public CSTNode set(int index, CSTNode element)

public CSTNode setMeaning(int meaning)

public int size()

public String toString()

public void write(PrintWriter writer)

protected void write(PrintWriter writer, String indent)