langtools/src/share/classes/com/sun/mirror/util/DeclarationVisitor.java
author darcy
Sun, 26 Jul 2009 21:27:11 -0700
changeset 3378 22011d9a9398
parent 10 06bc494ca11e
child 5520 86e4b9a9da40
permissions -rw-r--r--
6381698: Warn of decommissioning of apt Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
     2
 * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
 * have any questions.
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.mirror.util;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
import com.sun.mirror.declaration.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * A visitor for declarations, in the style of the standard visitor
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * design pattern.  Classes implementing this interface are used to
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * operate on a declaration when the kind of declaration is unknown at
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * compile time.  When a visitor is passed to a declaration's {@link
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * Declaration#accept accept} method, the most specific
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 * <tt>visit<i>Xxx</i></tt> method applicable to that declaration is
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * invoked.
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 *
3378
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    40
 * @deprecated All components of this API have been superseded by the
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    41
 * standardized annotation processing API.  The replacement for the
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    42
 * functionality of this interface is {@link
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    43
 * javax.lang.model.element.ElementVisitor}.
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    44
 *
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 * @author Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 * @author Scott Seligman
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
 * @since 1.5
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 */
3378
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    49
@Deprecated
22011d9a9398 6381698: Warn of decommissioning of apt
darcy
parents: 10
diff changeset
    50
@SuppressWarnings("deprecation")
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
public interface DeclarationVisitor {
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
     * Visits a declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    public void visitDeclaration(Declaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
     * Visits a package declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    public void visitPackageDeclaration(PackageDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * Visits a member or constructor declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    public void visitMemberDeclaration(MemberDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
     * Visits a type declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    public void visitTypeDeclaration(TypeDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
     * Visits a class declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
    public void visitClassDeclaration(ClassDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
     * Visits an enum declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    public void visitEnumDeclaration(EnumDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * Visits an interface declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
    public void visitInterfaceDeclaration(InterfaceDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
     * Visits an annotation type declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    public void visitAnnotationTypeDeclaration(AnnotationTypeDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     * Visits a field declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
    public void visitFieldDeclaration(FieldDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
     * Visits an enum constant declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
    public void visitEnumConstantDeclaration(EnumConstantDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
     * Visits a method or constructor declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
    public void visitExecutableDeclaration(ExecutableDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
     * Visits a constructor declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
    public void visitConstructorDeclaration(ConstructorDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
     * Visits a method declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
    public void visitMethodDeclaration(MethodDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
     * Visits an annotation type element declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
    public void visitAnnotationTypeElementDeclaration(
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
                                     AnnotationTypeElementDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
     * Visits a parameter declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   141
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
    public void visitParameterDeclaration(ParameterDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   143
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
     * Visits a type parameter declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
   146
     * @param d the declaration to visit
06bc494ca11e Initial load
duke
parents:
diff changeset
   147
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   148
    public void visitTypeParameterDeclaration(TypeParameterDeclaration d);
06bc494ca11e Initial load
duke
parents:
diff changeset
   149
}