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

Fri, 28 Jun 2013 13:20:44 +0100

author
vromero
date
Fri, 28 Jun 2013 13:20:44 +0100
changeset 1871
bb06c412d079
parent 1590
011cf7e0a148
child 2083
379c04c090cf
permissions
-rw-r--r--

6473148: TreePath.iterator() should document the iteration order
Reviewed-by: mcimadamore

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

mercurial