ParseTreeNodeVisitor.java

// Copyright (C) 2012 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.caja.parser;

/**
 * Callback for visiting a {@link ParseTreeNode} tree, used by
 * {@link ParseTreeNode#visitPreOrder}.
 * <p>
 * This is different from {@link Visitor} in that the node argument
 * is a ParseTreeNode, not an AncestorChain, so the visitor does
 * not know what the node's parent is.
 */
public interface ParseTreeNodeVisitor {
  /**
   * Called to visit each node in a ParseTreeNode tree.
   * @return Whether to continue.  Returning false will stop traversal.
   */
  public boolean visit(ParseTreeNode node);
}