Class ASTNode

src/main/java/org/codehaus/groovy/ast/ASTNode.java:42–210

Base class for any AST node. This class supports basic information used in all nodes of the AST: line and column number information. Usually a node represents a certain area in a text file determined by a starting position and an ending position. For nodes that do not represent this, this

 * </ul>
 */
public class ASTNode implements NodeMetaDataHandler {

    private int lineNumber = -1;
    private int columnNumber = -1;
    private int lastLineNumber = -1;
    private int lastColumnNumber = -1;

    private volatile Map<?, ?> metaDataMap;

    /**
     * Accepts a code visitor for AST traversal and transformation.
     * Subclasses must implement this method to support visitor pattern-based processing.
     * The visitor pattern enables decoupling of AST structure from processing logic.
     *
     * @param visitor the {@link GroovyCodeVisitor} to process this node
     * @throws RuntimeException if visitor pattern support is not implemented for this node type
     */
    public void visit(final GroovyCodeVisitor visitor) {
        throw new RuntimeException("No visit() method implemented for class: " + getClass().getName());
    }

    /**
     * Returns a human-readable text representation of this AST node.
     * Used for debugging and error messages. Default implementation returns a message
     * indicating the representation is not yet implemented for this node type.
     *
     * @return text representation of this node, or placeholder for unimplemented types
     */
    public String getText() {
        Class<?> nodeType = getClass();
        if (nodeType.isAnonymousClass()) nodeType = nodeType.getSuperclass();
        return "<not implemented yet for class: " + nodeType.getName() + ">";
    }

    /**
     * Returns the line number where this AST node begins in the source file.
     * Line numbers start from 1. Returns -1 if position information is not available
     * (for synthetic or generated nodes).
     *
     * @return the starting line number, or -1 if not available
     */
    public int getLineNumber() {
        return lineNumber;
    }

    /**
     * Sets the starting line number for this AST node in the source file.
     * Line numbers are 1-indexed. Use -1 to indicate unavailable position.
     *
     * @param lineNumber the starting line number to set
     */
    public void setLineNumber(final int lineNumber) {
        this.lineNumber = lineNumber;
    }

    /**
     * Returns the column number where this AST node begins in the source file.
     * Column numbers are 0-indexed. Returns -1 if position information is unavailable