• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/javax/lang/model/util/ElementKindVisitor8.java@c75be5bc5283 (annotated)

src/share/classes/javax/lang/model/util/ElementKindVisitor8.java

Tue, 09 Oct 2012 19:10:00 -0700

author

jjg

date

Tue, 09 Oct 2012 19:10:00 -0700

changeset 1357

c75be5bc5283

parent 1054

111bbf1ad913

child 1448

7d34e91f66bb

permissions

-rw-r--r--

8000663: clean up langtools imports
Reviewed-by: darcy

darcy@1054	1	/*
darcy@1054	2	* Copyright (c) 2011 Oracle and/or its affiliates. All rights reserved.
darcy@1054	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
darcy@1054	4	*
darcy@1054	5	* This code is free software; you can redistribute it and/or modify it
darcy@1054	6	* under the terms of the GNU General Public License version 2 only, as
darcy@1054	7	* published by the Free Software Foundation. Oracle designates this
darcy@1054	8	* particular file as subject to the "Classpath" exception as provided
darcy@1054	9	* by Oracle in the LICENSE file that accompanied this code.
darcy@1054	10	*
darcy@1054	11	* This code is distributed in the hope that it will be useful, but WITHOUT
darcy@1054	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
darcy@1054	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
darcy@1054	14	* version 2 for more details (a copy is included in the LICENSE file that
darcy@1054	15	* accompanied this code).
darcy@1054	16	*
darcy@1054	17	* You should have received a copy of the GNU General Public License version
darcy@1054	18	* 2 along with this work; if not, write to the Free Software Foundation,
darcy@1054	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
darcy@1054	20	*
darcy@1054	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
darcy@1054	22	* or visit www.oracle.com if you need additional information or have any
darcy@1054	23	* questions.
darcy@1054	24	*/
darcy@1054	25
darcy@1054	26	package javax.lang.model.util;
darcy@1054	27
darcy@1054	28	import javax.lang.model.element.*;
darcy@1054	29	import javax.annotation.processing.SupportedSourceVersion;
darcy@1054	30	import static javax.lang.model.SourceVersion.*;
darcy@1054	31	import javax.lang.model.SourceVersion;
darcy@1054	32
darcy@1054	33	/**
darcy@1054	34	* A visitor of program elements based on their {@linkplain
darcy@1054	35	* ElementKind kind} with default behavior appropriate for the {@link
darcy@1054	36	* SourceVersion#RELEASE_8 RELEASE_8} source version. For {@linkplain
darcy@1054	37	* Element elements} <tt><i>XYZ</i></tt> that may have more than one
darcy@1054	38	* kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate
darcy@1054	39	* to the <tt>visit<i>XYZKind</i></tt> method corresponding to the
darcy@1054	40	* first argument's kind. The <tt>visit<i>XYZKind</i></tt> methods
darcy@1054	41	* call {@link #defaultAction defaultAction}, passing their arguments
darcy@1054	42	* to {@code defaultAction}'s corresponding parameters.
darcy@1054	43	*
darcy@1054	44	* <p> Methods in this class may be overridden subject to their
darcy@1054	45	* general contract. Note that annotating methods in concrete
darcy@1054	46	* subclasses with {@link java.lang.Override @Override} will help
darcy@1054	47	* ensure that methods are overridden as intended.
darcy@1054	48	*
darcy@1054	49	* <p> <b>WARNING:</b> The {@code ElementVisitor} interface
darcy@1054	50	* implemented by this class may have methods added to it or the
darcy@1054	51	* {@code ElementKind} {@code enum} used in this case may have
darcy@1054	52	* constants added to it in the future to accommodate new, currently
darcy@1054	53	* unknown, language structures added to future versions of the
darcy@1054	54	* Java&trade; programming language. Therefore, methods whose names
darcy@1054	55	* begin with {@code "visit"} may be added to this class in the
darcy@1054	56	* future; to avoid incompatibilities, classes which extend this class
darcy@1054	57	* should not declare any instance methods with names beginning with
darcy@1054	58	* {@code "visit"}.
darcy@1054	59	*
darcy@1054	60	* <p>When such a new visit method is added, the default
darcy@1054	61	* implementation in this class will be to call the {@link
darcy@1054	62	* #visitUnknown visitUnknown} method. A new abstract element kind
darcy@1054	63	* visitor class will also be introduced to correspond to the new
darcy@1054	64	* language level; this visitor will have different default behavior
darcy@1054	65	* for the visit method in question. When the new visitor is
darcy@1054	66	* introduced, all or portions of this visitor may be deprecated.
darcy@1054	67	*
darcy@1054	68	* @param <R> the return type of this visitor's methods. Use {@link
darcy@1054	69	* Void} for visitors that do not need to return results.
darcy@1054	70	* @param <P> the type of the additional parameter to this visitor's
darcy@1054	71	* methods. Use {@code Void} for visitors that do not need an
darcy@1054	72	* additional parameter.
darcy@1054	73	*
darcy@1054	74	* @see ElementKindVisitor6
darcy@1054	75	* @see ElementKindVisitor7
darcy@1054	76	* @since 1.8
darcy@1054	77	*/
darcy@1054	78	@SupportedSourceVersion(RELEASE_8)
darcy@1054	79	public class ElementKindVisitor8<R, P> extends ElementKindVisitor7<R, P> {
darcy@1054	80	/**
darcy@1054	81	* Constructor for concrete subclasses; uses {@code null} for the
darcy@1054	82	* default value.
darcy@1054	83	*/
darcy@1054	84	protected ElementKindVisitor8() {
darcy@1054	85	super(null);
darcy@1054	86	}
darcy@1054	87
darcy@1054	88	/**
darcy@1054	89	* Constructor for concrete subclasses; uses the argument for the
darcy@1054	90	* default value.
darcy@1054	91	*
darcy@1054	92	* @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
darcy@1054	93	*/
darcy@1054	94	protected ElementKindVisitor8(R defaultValue) {
darcy@1054	95	super(defaultValue);
darcy@1054	96	}
darcy@1054	97	}