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

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

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

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 1522

09f65aad4759

parent 0

959103a6100f

permissions

-rw-r--r--

merge

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