src/share/classes/com/sun/source/tree/TreeVisitor.java

Fri, 26 Jun 2009 19:12:41 -0700

author
jjg
date
Fri, 26 Jun 2009 19:12:41 -0700
changeset 309
664edca41e34
parent 308
03944ee4fac4
child 550
a6f2911a7c55
permissions
-rw-r--r--

6855544: add missing files
Reviewed-by: jjg, mcimadamore, darcy
Contributed-by: mernst@cs.washington.edu, mali@csail.mit.edu, mpapi@csail.mit.edu

duke@1 1 /*
duke@1 2 * Copyright 2005-2006 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.source.tree;
duke@1 27
duke@1 28 /**
duke@1 29 * A visitor of trees, in the style of the visitor design pattern.
duke@1 30 * Classes implementing this interface are used to operate
duke@1 31 * on a tree when the kind of tree is unknown at compile time.
duke@1 32 * When a visitor is passed to an tree's {@link Tree#accept
duke@1 33 * accept} method, the <tt>visit<i>XYZ</i></tt> method most applicable
duke@1 34 * to that tree is invoked.
duke@1 35 *
duke@1 36 * <p> Classes implementing this interface may or may not throw a
duke@1 37 * {@code NullPointerException} if the additional parameter {@code p}
duke@1 38 * is {@code null}; see documentation of the implementing class for
duke@1 39 * details.
duke@1 40 *
duke@1 41 * <p> <b>WARNING:</b> It is possible that methods will be added to
duke@1 42 * this interface to accommodate new, currently unknown, language
duke@1 43 * structures added to future versions of the Java&trade; programming
duke@1 44 * language. Therefore, visitor classes directly implementing this
duke@1 45 * interface may be source incompatible with future versions of the
duke@1 46 * platform.
duke@1 47 *
duke@1 48 * @param <R> the return type of this visitor's methods. Use {@link
duke@1 49 * Void} for visitors that do not need to return results.
duke@1 50 * @param <P> the type of the additional parameter to this visitor's
duke@1 51 * methods. Use {@code Void} for visitors that do not need an
duke@1 52 * additional parameter.
duke@1 53 *
duke@1 54 * @author Peter von der Ah&eacute;
duke@1 55 * @author Jonathan Gibbons
duke@1 56 *
duke@1 57 * @since 1.6
duke@1 58 */
duke@1 59 public interface TreeVisitor<R,P> {
jjg@308 60 R visitAnnotatedType(AnnotatedTypeTree node, P p);
duke@1 61 R visitAnnotation(AnnotationTree node, P p);
duke@1 62 R visitMethodInvocation(MethodInvocationTree node, P p);
duke@1 63 R visitAssert(AssertTree node, P p);
duke@1 64 R visitAssignment(AssignmentTree node, P p);
duke@1 65 R visitCompoundAssignment(CompoundAssignmentTree node, P p);
duke@1 66 R visitBinary(BinaryTree node, P p);
duke@1 67 R visitBlock(BlockTree node, P p);
duke@1 68 R visitBreak(BreakTree node, P p);
duke@1 69 R visitCase(CaseTree node, P p);
duke@1 70 R visitCatch(CatchTree node, P p);
duke@1 71 R visitClass(ClassTree node, P p);
duke@1 72 R visitConditionalExpression(ConditionalExpressionTree node, P p);
duke@1 73 R visitContinue(ContinueTree node, P p);
duke@1 74 R visitDoWhileLoop(DoWhileLoopTree node, P p);
duke@1 75 R visitErroneous(ErroneousTree node, P p);
duke@1 76 R visitExpressionStatement(ExpressionStatementTree node, P p);
duke@1 77 R visitEnhancedForLoop(EnhancedForLoopTree node, P p);
duke@1 78 R visitForLoop(ForLoopTree node, P p);
duke@1 79 R visitIdentifier(IdentifierTree node, P p);
duke@1 80 R visitIf(IfTree node, P p);
duke@1 81 R visitImport(ImportTree node, P p);
duke@1 82 R visitArrayAccess(ArrayAccessTree node, P p);
duke@1 83 R visitLabeledStatement(LabeledStatementTree node, P p);
duke@1 84 R visitLiteral(LiteralTree node, P p);
duke@1 85 R visitMethod(MethodTree node, P p);
duke@1 86 R visitModifiers(ModifiersTree node, P p);
duke@1 87 R visitNewArray(NewArrayTree node, P p);
duke@1 88 R visitNewClass(NewClassTree node, P p);
duke@1 89 R visitParenthesized(ParenthesizedTree node, P p);
duke@1 90 R visitReturn(ReturnTree node, P p);
duke@1 91 R visitMemberSelect(MemberSelectTree node, P p);
duke@1 92 R visitEmptyStatement(EmptyStatementTree node, P p);
duke@1 93 R visitSwitch(SwitchTree node, P p);
duke@1 94 R visitSynchronized(SynchronizedTree node, P p);
duke@1 95 R visitThrow(ThrowTree node, P p);
duke@1 96 R visitCompilationUnit(CompilationUnitTree node, P p);
duke@1 97 R visitTry(TryTree node, P p);
duke@1 98 R visitParameterizedType(ParameterizedTypeTree node, P p);
duke@1 99 R visitArrayType(ArrayTypeTree node, P p);
duke@1 100 R visitTypeCast(TypeCastTree node, P p);
duke@1 101 R visitPrimitiveType(PrimitiveTypeTree node, P p);
duke@1 102 R visitTypeParameter(TypeParameterTree node, P p);
duke@1 103 R visitInstanceOf(InstanceOfTree node, P p);
duke@1 104 R visitUnary(UnaryTree node, P p);
duke@1 105 R visitVariable(VariableTree node, P p);
duke@1 106 R visitWhileLoop(WhileLoopTree node, P p);
duke@1 107 R visitWildcard(WildcardTree node, P p);
duke@1 108 R visitOther(Tree node, P p);
duke@1 109 }

mercurial