001: /*
002: * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.source.tree;
027:
028: /**
029: * A visitor of trees, in the style of the visitor design pattern.
030: * Classes implementing this interface are used to operate
031: * on a tree when the kind of tree is unknown at compile time.
032: * When a visitor is passed to an tree's {@link Tree#accept
033: * accept} method, the <tt>visit<i>XYZ</i></tt> method most applicable
034: * to that tree is invoked.
035: *
036: * <p> Classes implementing this interface may or may not throw a
037: * {@code NullPointerException} if the additional parameter {@code p}
038: * is {@code null}; see documentation of the implementing class for
039: * details.
040: *
041: * <p> <b>WARNING:</b> It is possible that methods will be added to
042: * this interface to accommodate new, currently unknown, language
043: * structures added to future versions of the Java™ programming
044: * language. Therefore, visitor classes directly implementing this
045: * interface may be source incompatible with future versions of the
046: * platform.
047: *
048: * @param <R> the return type of this visitor's methods. Use {@link
049: * Void} for visitors that do not need to return results.
050: * @param <P> the type of the additional parameter to this visitor's
051: * methods. Use {@code Void} for visitors that do not need an
052: * additional parameter.
053: *
054: * @author Peter von der Ahé
055: * @author Jonathan Gibbons
056: *
057: * @since 1.6
058: */
059: public interface TreeVisitor<R, P> {
060: R visitAnnotation(AnnotationTree node, P p);
061:
062: R visitMethodInvocation(MethodInvocationTree node, P p);
063:
064: R visitAssert(AssertTree node, P p);
065:
066: R visitAssignment(AssignmentTree node, P p);
067:
068: R visitCompoundAssignment(CompoundAssignmentTree node, P p);
069:
070: R visitBinary(BinaryTree node, P p);
071:
072: R visitBlock(BlockTree node, P p);
073:
074: R visitBreak(BreakTree node, P p);
075:
076: R visitCase(CaseTree node, P p);
077:
078: R visitCatch(CatchTree node, P p);
079:
080: R visitClass(ClassTree node, P p);
081:
082: R visitConditionalExpression(ConditionalExpressionTree node, P p);
083:
084: R visitContinue(ContinueTree node, P p);
085:
086: R visitDoWhileLoop(DoWhileLoopTree node, P p);
087:
088: R visitErroneous(ErroneousTree node, P p);
089:
090: R visitExpressionStatement(ExpressionStatementTree node, P p);
091:
092: R visitEnhancedForLoop(EnhancedForLoopTree node, P p);
093:
094: R visitForLoop(ForLoopTree node, P p);
095:
096: R visitIdentifier(IdentifierTree node, P p);
097:
098: R visitIf(IfTree node, P p);
099:
100: R visitImport(ImportTree node, P p);
101:
102: R visitArrayAccess(ArrayAccessTree node, P p);
103:
104: R visitLabeledStatement(LabeledStatementTree node, P p);
105:
106: R visitLiteral(LiteralTree node, P p);
107:
108: R visitMethod(MethodTree node, P p);
109:
110: R visitModifiers(ModifiersTree node, P p);
111:
112: R visitNewArray(NewArrayTree node, P p);
113:
114: R visitNewClass(NewClassTree node, P p);
115:
116: R visitParenthesized(ParenthesizedTree node, P p);
117:
118: R visitReturn(ReturnTree node, P p);
119:
120: R visitMemberSelect(MemberSelectTree node, P p);
121:
122: R visitEmptyStatement(EmptyStatementTree node, P p);
123:
124: R visitSwitch(SwitchTree node, P p);
125:
126: R visitSynchronized(SynchronizedTree node, P p);
127:
128: R visitThrow(ThrowTree node, P p);
129:
130: R visitCompilationUnit(CompilationUnitTree node, P p);
131:
132: R visitTry(TryTree node, P p);
133:
134: R visitParameterizedType(ParameterizedTypeTree node, P p);
135:
136: R visitArrayType(ArrayTypeTree node, P p);
137:
138: R visitTypeCast(TypeCastTree node, P p);
139:
140: R visitPrimitiveType(PrimitiveTypeTree node, P p);
141:
142: R visitTypeParameter(TypeParameterTree node, P p);
143:
144: R visitInstanceOf(InstanceOfTree node, P p);
145:
146: R visitUnary(UnaryTree node, P p);
147:
148: R visitVariable(VariableTree node, P p);
149:
150: R visitWhileLoop(WhileLoopTree node, P p);
151:
152: R visitWildcard(WildcardTree node, P p);
153:
154: R visitOther(Tree node, P p);
155: }
|