src/share/classes/com/sun/source/util/TreePathScanner.java

Tue, 19 Feb 2013 00:31:45 -0800

author
darcy
date
Tue, 19 Feb 2013 00:31:45 -0800
changeset 1590
011cf7e0a148
parent 554
9d9f26857129
child 2083
379c04c090cf
permissions
-rw-r--r--

8008267: Add @Supported annotation to com.sun.source types
Reviewed-by: jjg

duke@1 1 /*
darcy@1590 2 * Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.source.util;
duke@1 27
duke@1 28 import com.sun.source.tree.*;
duke@1 29
duke@1 30 /**
duke@1 31 * A TreeVisitor that visits all the child tree nodes, and provides
duke@1 32 * support for maintaining a path for the parent nodes.
duke@1 33 * To visit nodes of a particular type, just override the
duke@1 34 * corresponding visitorXYZ method.
duke@1 35 * Inside your method, call super.visitXYZ to visit descendant
duke@1 36 * nodes.
duke@1 37 *
duke@1 38 * @author Jonathan Gibbons
duke@1 39 * @since 1.6
duke@1 40 */
darcy@1590 41 @jdk.Supported
duke@1 42 public class TreePathScanner<R, P> extends TreeScanner<R, P> {
duke@1 43
duke@1 44 /**
duke@1 45 * Scan a tree from a position identified by a TreePath.
duke@1 46 */
duke@1 47 public R scan(TreePath path, P p) {
duke@1 48 this.path = path;
duke@1 49 try {
duke@1 50 return path.getLeaf().accept(this, p);
duke@1 51 } finally {
duke@1 52 this.path = null;
duke@1 53 }
duke@1 54 }
duke@1 55
duke@1 56 /**
duke@1 57 * Scan a single node.
duke@1 58 * The current path is updated for the duration of the scan.
duke@1 59 */
duke@1 60 @Override
duke@1 61 public R scan(Tree tree, P p) {
duke@1 62 if (tree == null)
duke@1 63 return null;
duke@1 64
duke@1 65 TreePath prev = path;
duke@1 66 path = new TreePath(path, tree);
duke@1 67 try {
duke@1 68 return tree.accept(this, p);
duke@1 69 } finally {
duke@1 70 path = prev;
duke@1 71 }
duke@1 72 }
duke@1 73
duke@1 74 /**
duke@1 75 * Get the current path for the node, as built up by the currently
duke@1 76 * active set of scan calls.
duke@1 77 */
duke@1 78 public TreePath getCurrentPath() {
duke@1 79 return path;
duke@1 80 }
duke@1 81
duke@1 82 private TreePath path;
duke@1 83 }

mercurial