org.mozilla.javascript.ast.NodeVisitor Maven / Gradle / Ivy
The newest version!
/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.javascript.ast;
/**
* Simple visitor interface for traversing the AST. The nodes are visited in
* an arbitrary order. The visitor must cast nodes to the appropriate
* type based on their token-type.
*/
public interface NodeVisitor {
/**
* Visits an AST node.
* @param node the AST node. Will never visit an {@link AstRoot} node,
* since the {@code AstRoot} is where the visiting begins.
* @return {@code true} if the children should be visited.
* If {@code false}, the subtree rooted at this node is skipped.
* The {@code node} argument should never be {@code null} --
* the individual {@link AstNode} classes should skip any children
* that are not present in the source when they invoke this method.
*/
boolean visit(AstNode node);
}