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

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 554
9d9f26857129
child 1357
c75be5bc5283
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

duke@1 1 /*
ohair@554 2 * Copyright (c) 2006, 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 import java.util.Iterator;
duke@1 30
duke@1 31 /**
duke@1 32 * A path of tree nodes, typically used to represent the sequence of ancestor
duke@1 33 * nodes of a tree node up to the top level CompilationUnitTree node.
duke@1 34 *
duke@1 35 * @author Jonathan Gibbons
duke@1 36 * @since 1.6
duke@1 37 */
duke@1 38 public class TreePath implements Iterable<Tree> {
duke@1 39 /**
duke@1 40 * Gets a tree path for a tree node within a compilation unit.
duke@1 41 * @return null if the node is not found
duke@1 42 */
duke@1 43 public static TreePath getPath(CompilationUnitTree unit, Tree target) {
duke@1 44 return getPath(new TreePath(unit), target);
duke@1 45 }
duke@1 46
duke@1 47 /**
duke@1 48 * Gets a tree path for a tree node within a subtree identified by a TreePath object.
duke@1 49 * @return null if the node is not found
duke@1 50 */
duke@1 51 public static TreePath getPath(TreePath path, Tree target) {
duke@1 52 path.getClass();
duke@1 53 target.getClass();
duke@1 54
duke@1 55 class Result extends Error {
duke@1 56 static final long serialVersionUID = -5942088234594905625L;
duke@1 57 TreePath path;
duke@1 58 Result(TreePath path) {
duke@1 59 this.path = path;
duke@1 60 }
duke@1 61 }
duke@1 62 class PathFinder extends TreePathScanner<TreePath,Tree> {
duke@1 63 public TreePath scan(Tree tree, Tree target) {
duke@1 64 if (tree == target)
duke@1 65 throw new Result(new TreePath(getCurrentPath(), target));
duke@1 66 return super.scan(tree, target);
duke@1 67 }
duke@1 68 }
duke@1 69
duke@1 70 try {
duke@1 71 new PathFinder().scan(path, target);
duke@1 72 } catch (Result result) {
duke@1 73 return result.path;
duke@1 74 }
duke@1 75 return null;
duke@1 76 }
duke@1 77
duke@1 78 /**
duke@1 79 * Creates a TreePath for a root node.
duke@1 80 */
duke@1 81 public TreePath(CompilationUnitTree t) {
duke@1 82 this(null, t);
duke@1 83 }
duke@1 84
duke@1 85 /**
duke@1 86 * Creates a TreePath for a child node.
duke@1 87 */
duke@1 88 public TreePath(TreePath p, Tree t) {
duke@1 89 if (t.getKind() == Tree.Kind.COMPILATION_UNIT) {
duke@1 90 compilationUnit = (CompilationUnitTree) t;
duke@1 91 parent = null;
duke@1 92 }
duke@1 93 else {
duke@1 94 compilationUnit = p.compilationUnit;
duke@1 95 parent = p;
duke@1 96 }
duke@1 97 leaf = t;
duke@1 98 }
duke@1 99 /**
duke@1 100 * Get the compilation unit associated with this path.
duke@1 101 */
duke@1 102 public CompilationUnitTree getCompilationUnit() {
duke@1 103 return compilationUnit;
duke@1 104 }
duke@1 105
duke@1 106 /**
duke@1 107 * Get the leaf node for this path.
duke@1 108 */
duke@1 109 public Tree getLeaf() {
duke@1 110 return leaf;
duke@1 111 }
duke@1 112
duke@1 113 /**
duke@1 114 * Get the path for the enclosing node, or null if there is no enclosing node.
duke@1 115 */
duke@1 116 public TreePath getParentPath() {
duke@1 117 return parent;
duke@1 118 }
duke@1 119
duke@1 120 public Iterator<Tree> iterator() {
duke@1 121 return new Iterator<Tree>() {
duke@1 122 public boolean hasNext() {
jjg@308 123 return next != null;
duke@1 124 }
duke@1 125
duke@1 126 public Tree next() {
jjg@308 127 Tree t = next.leaf;
jjg@308 128 next = next.parent;
jjg@308 129 return t;
duke@1 130 }
duke@1 131
duke@1 132 public void remove() {
duke@1 133 throw new UnsupportedOperationException();
duke@1 134 }
duke@1 135
jjg@308 136 private TreePath next = TreePath.this;
duke@1 137 };
duke@1 138 }
duke@1 139
duke@1 140 private CompilationUnitTree compilationUnit;
duke@1 141 private Tree leaf;
duke@1 142 private TreePath parent;
duke@1 143 }

mercurial