src/java.compiler/share/classes/javax/lang/model/util/ElementScanner8.java
author darcy
Wed, 11 Jul 2018 08:24:39 -0700
changeset 50964 225b61293064
parent 47216 71c04702a3d5
permissions -rw-r--r--
8173606: Deprecate constructors of 7-era visitors Reviewed-by: vromero, jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     1
/*
50964
225b61293064 8173606: Deprecate constructors of 7-era visitors
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 2011, 2018, Oracle and/or its affiliates. All rights reserved.
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     4
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    10
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    15
 * accompanied this code).
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    16
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    20
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    23
 * questions.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    24
 */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    25
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    26
package javax.lang.model.util;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    27
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    28
import javax.lang.model.element.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    29
import javax.annotation.processing.SupportedSourceVersion;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    30
import javax.lang.model.SourceVersion;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    31
import static javax.lang.model.SourceVersion.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    32
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    33
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    34
/**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    35
 * A scanning visitor of program elements with default behavior
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    36
 * appropriate for the {@link SourceVersion#RELEASE_8 RELEASE_8}
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    37
 * source version.  The <code>visit<i>Xyz</i></code> methods in this
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    38
 * class scan their component elements by calling {@code scan} on
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    39
 * their {@linkplain Element#getEnclosedElements enclosed elements},
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    40
 * {@linkplain ExecutableElement#getParameters parameters}, etc., as
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    41
 * indicated in the individual method specifications.  A subclass can
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    42
 * control the order elements are visited by overriding the
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    43
 * <code>visit<i>Xyz</i></code> methods.  Note that clients of a scanner
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    44
 * may get the desired behavior be invoking {@code v.scan(e, p)} rather
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    45
 * than {@code v.visit(e, p)} on the root objects of interest.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    46
 *
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    47
 * <p>When a subclass overrides a <code>visit<i>Xyz</i></code> method, the
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    48
 * new method can cause the enclosed elements to be scanned in the
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    49
 * default way by calling <code>super.visit<i>Xyz</i></code>.  In this
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    50
 * fashion, the concrete visitor can control the ordering of traversal
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    51
 * over the component elements with respect to the additional
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    52
 * processing; for example, consistently calling
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    53
 * <code>super.visit<i>Xyz</i></code> at the start of the overridden
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    54
 * methods will yield a preorder traversal, etc.  If the component
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    55
 * elements should be traversed in some other order, instead of
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    56
 * calling <code>super.visit<i>Xyz</i></code>, an overriding visit method
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    57
 * should call {@code scan} with the elements in the desired order.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    58
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    59
 * <p> Methods in this class may be overridden subject to their
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    60
 * general contract.  Note that annotating methods in concrete
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    61
 * subclasses with {@link java.lang.Override @Override} will help
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    62
 * ensure that methods are overridden as intended.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    63
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    64
 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    65
 * implemented by this class may have methods added to it in the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    66
 * future to accommodate new, currently unknown, language structures
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    67
 * added to future versions of the Java&trade; programming language.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    68
 * Therefore, methods whose names begin with {@code "visit"} may be
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    69
 * added to this class in the future; to avoid incompatibilities,
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    70
 * classes which extend this class should not declare any instance
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    71
 * methods with names beginning with {@code "visit"}.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    72
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    73
 * <p>When such a new visit method is added, the default
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    74
 * implementation in this class will be to call the {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    75
 * #visitUnknown visitUnknown} method.  A new element scanner visitor
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    76
 * class will also be introduced to correspond to the new language
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    77
 * level; this visitor will have different default behavior for the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    78
 * visit method in question.  When the new visitor is introduced, all
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    79
 * or portions of this visitor may be deprecated.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    80
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    81
 * @param <R> the return type of this visitor's methods.  Use {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    82
 *            Void} for visitors that do not need to return results.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    83
 * @param <P> the type of the additional parameter to this visitor's
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    84
 *            methods.  Use {@code Void} for visitors that do not need an
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    85
 *            additional parameter.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    86
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    87
 * @see ElementScanner6
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    88
 * @see ElementScanner7
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 18392
diff changeset
    89
 * @see ElementScanner9
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    90
 * @since 1.8
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    91
 */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    92
@SupportedSourceVersion(RELEASE_8)
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    93
public class ElementScanner8<R, P> extends ElementScanner7<R, P> {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    94
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    95
     * Constructor for concrete subclasses; uses {@code null} for the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    96
     * default value.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    97
     */
50964
225b61293064 8173606: Deprecate constructors of 7-era visitors
darcy
parents: 47216
diff changeset
    98
    @SuppressWarnings("deprecation") // Superclass constructor deprecated
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    99
    protected ElementScanner8(){
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   100
        super(null);
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   101
    }
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   102
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   103
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   104
     * Constructor for concrete subclasses; uses the argument for the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   105
     * default value.
18392
de0ad9c84ce8 8016779: Fix doclint warnings in javax.lang.model
darcy
parents: 14258
diff changeset
   106
     *
de0ad9c84ce8 8016779: Fix doclint warnings in javax.lang.model
darcy
parents: 14258
diff changeset
   107
     * @param defaultValue the default value
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   108
     */
50964
225b61293064 8173606: Deprecate constructors of 7-era visitors
darcy
parents: 47216
diff changeset
   109
    @SuppressWarnings("deprecation") // Superclass constructor deprecated
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   110
    protected ElementScanner8(R defaultValue){
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   111
        super(defaultValue);
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   112
    }
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   113
}