< prev index next >

src/java.compiler/share/classes/javax/lang/model/util/TypeKindVisitor6.java

Print this page




  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.lang.model.util;
  27 
  28 import javax.annotation.processing.SupportedSourceVersion;
  29 import javax.lang.model.SourceVersion;
  30 import javax.lang.model.type.*;
  31 import static javax.lang.model.SourceVersion.*;
  32 
  33 /**
  34  * A visitor of types based on their {@linkplain TypeKind kind} with
  35  * default behavior appropriate for the {@link SourceVersion#RELEASE_6
  36  * RELEASE_6} source version.  For {@linkplain
  37  * TypeMirror types} <code><i>XYZ</i></code> that may have more than one
  38  * kind, the <code>visit<i>XYZ</i></code> methods in this class delegate
  39  * to the <code>visit<i>XYZKind</i></code> method corresponding to the
  40  * first argument's kind.  The <code>visit<i>XYZKind</i></code> methods
  41  * call {@link #defaultAction defaultAction}, passing their arguments
  42  * to {@code defaultAction}'s corresponding parameters.
  43  *
  44  * <p> Methods in this class may be overridden subject to their
  45  * general contract.  Note that annotating methods in concrete
  46  * subclasses with {@link java.lang.Override @Override} will help
  47  * ensure that methods are overridden as intended.
  48  *
  49  * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
  50  * by this class may have methods added to it in the future to
  51  * accommodate new, currently unknown, language structures added to
  52  * future versions of the Java&trade; programming language.
  53  * Therefore, methods whose names begin with {@code "visit"} may be
  54  * added to this class in the future; to avoid incompatibilities,
  55  * classes which extend this class should not declare any instance
  56  * methods with names beginning with {@code "visit"}.
  57  *
  58  * <p>When such a new visit method is added, the default
  59  * implementation in this class will be to call the {@link
  60  * #visitUnknown visitUnknown} method.  A new type kind visitor class
  61  * will also be introduced to correspond to the new language level;
  62  * this visitor will have different default behavior for the visit
  63  * method in question.  When the new visitor is introduced, all or
  64  * portions of this visitor may be deprecated.
  65  *
  66  * <p>Note that adding a default implementation of a new visit method
  67  * in a visitor class will occur instead of adding a <em>default
  68  * method</em> directly in the visitor interface since a Java SE 8
  69  * language feature cannot be used to this version of the API since
  70  * this version is required to be runnable on Java SE 7
  71  * implementations.  Future versions of the API that are only required
  72  * to run on Java SE 8 and later may take advantage of default methods
  73  * in this situation.
  74  *
  75  * @param <R> the return type of this visitor's methods.  Use {@link
  76  *            Void} for visitors that do not need to return results.
  77  * @param <P> the type of the additional parameter to this visitor's
  78  *            methods.  Use {@code Void} for visitors that do not need an
  79  *            additional parameter.
  80  *
  81  * @author Joseph D. Darcy
  82  * @author Scott Seligman
  83  * @author Peter von der Ah&eacute;
  84  *
  85  * @see TypeKindVisitor7
  86  * @see TypeKindVisitor8
  87  * @since 1.6
  88  * @deprecated Release 6 is obsolete; update to a visitor for a newer
  89  * release level.
  90  */
  91 @Deprecated
  92 @SupportedSourceVersion(RELEASE_6)
  93 public class TypeKindVisitor6<R, P> extends SimpleTypeVisitor6<R, P> {




  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.lang.model.util;
  27 
  28 import javax.annotation.processing.SupportedSourceVersion;
  29 import javax.lang.model.SourceVersion;
  30 import javax.lang.model.type.*;
  31 import static javax.lang.model.SourceVersion.*;
  32 
  33 /**
  34  * A visitor of types based on their {@linkplain TypeKind kind} with
  35  * default behavior appropriate for the {@link SourceVersion#RELEASE_6
  36  * RELEASE_6} source version.  For {@linkplain
  37  * TypeMirror types} <code><i>Xyz</i></code> that may have more than one
  38  * kind, the <code>visit<i>Xyz</i></code> methods in this class delegate
  39  * to the <code>visit<i>Xyz</i>As<i>Kind</i></code> method corresponding to the
  40  * first argument's kind.  The <code>visit<i>Xyz</i>As<i>Kind</i></code> methods
  41  * call {@link #defaultAction defaultAction}, passing their arguments
  42  * to {@code defaultAction}'s corresponding parameters.
  43  *
  44  * <p> Methods in this class may be overridden subject to their
  45  * general contract.  Note that annotating methods in concrete
  46  * subclasses with {@link java.lang.Override @Override} will help
  47  * ensure that methods are overridden as intended.
  48  *
  49  * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
  50  * by this class may have methods added to it in the future to
  51  * accommodate new, currently unknown, language structures added to
  52  * future versions of the Java&trade; programming language.
  53  * Therefore, methods whose names begin with {@code "visit"} may be
  54  * added to this class in the future; to avoid incompatibilities,
  55  * classes which extend this class should not declare any instance
  56  * methods with names beginning with {@code "visit"}.
  57  *
  58  * <p>When such a new visit method is added, the default
  59  * implementation in this class will be to call the {@link
  60  * #visitUnknown visitUnknown} method.  A new type kind visitor class
  61  * will also be introduced to correspond to the new language level;
  62  * this visitor will have different default behavior for the visit
  63  * method in question.  When the new visitor is introduced, all or
  64  * portions of this visitor may be deprecated.









  65  *
  66  * @param <R> the return type of this visitor's methods.  Use {@link
  67  *            Void} for visitors that do not need to return results.
  68  * @param <P> the type of the additional parameter to this visitor's
  69  *            methods.  Use {@code Void} for visitors that do not need an
  70  *            additional parameter.
  71  *
  72  * @author Joseph D. Darcy
  73  * @author Scott Seligman
  74  * @author Peter von der Ah&eacute;
  75  *
  76  * @see TypeKindVisitor7
  77  * @see TypeKindVisitor8
  78  * @since 1.6
  79  * @deprecated Release 6 is obsolete; update to a visitor for a newer
  80  * release level.
  81  */
  82 @Deprecated
  83 @SupportedSourceVersion(RELEASE_6)
  84 public class TypeKindVisitor6<R, P> extends SimpleTypeVisitor6<R, P> {


< prev index next >