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

src/share/classes/javax/lang/model/util/AbstractElementVisitor6.java@959103a6100f (annotated)

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

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2005, 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.annotation.processing.SupportedSourceVersion;
aoqi@0	29	import javax.lang.model.SourceVersion;
aoqi@0	30	import javax.lang.model.element.*;
aoqi@0	31	import static javax.lang.model.SourceVersion.*;
aoqi@0	32
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* A skeletal visitor of program elements with default behavior
aoqi@0	36	* appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
aoqi@0	37	* source version.
aoqi@0	38	*
aoqi@0	39	* <p> <b>WARNING:</b> The {@code ElementVisitor} interface
aoqi@0	40	* implemented by this class may have methods added to it in the
aoqi@0	41	* future to accommodate new, currently unknown, language structures
aoqi@0	42	* added to future versions of the Java&trade; programming language.
aoqi@0	43	* Therefore, methods whose names begin with {@code "visit"} may be
aoqi@0	44	* added to this class in the future; to avoid incompatibilities,
aoqi@0	45	* classes which extend this class should not declare any instance
aoqi@0	46	* methods with names beginning with {@code "visit"}.
aoqi@0	47	*
aoqi@0	48	* <p>When such a new visit method is added, the default
aoqi@0	49	* implementation in this class will be to call the {@link
aoqi@0	50	* #visitUnknown visitUnknown} method. A new abstract element visitor
aoqi@0	51	* class will also be introduced to correspond to the new language
aoqi@0	52	* level; this visitor will have different default behavior for the
aoqi@0	53	* visit method in question. When the new visitor is introduced, all
aoqi@0	54	* or portions of this visitor may be deprecated.
aoqi@0	55	*
aoqi@0	56	* <p>Note that adding a default implementation of a new visit method
aoqi@0	57	* in a visitor class will occur instead of adding a <em>default
aoqi@0	58	* method</em> directly in the visitor interface since a Java SE 8
aoqi@0	59	* language feature cannot be used to this version of the API since
aoqi@0	60	* this version is required to be runnable on Java SE 7
aoqi@0	61	* implementations. Future versions of the API that are only required
aoqi@0	62	* to run on Java SE 8 and later may take advantage of default methods
aoqi@0	63	* in this situation.
aoqi@0	64	*
aoqi@0	65	* @param <R> the return type of this visitor's methods. Use {@link
aoqi@0	66	* Void} for visitors that do not need to return results.
aoqi@0	67	* @param <P> the type of the additional parameter to this visitor's
aoqi@0	68	* methods. Use {@code Void} for visitors that do not need an
aoqi@0	69	* additional parameter.
aoqi@0	70	*
aoqi@0	71	* @author Joseph D. Darcy
aoqi@0	72	* @author Scott Seligman
aoqi@0	73	* @author Peter von der Ah&eacute;
aoqi@0	74	*
aoqi@0	75	* @see AbstractElementVisitor7
aoqi@0	76	* @see AbstractElementVisitor8
aoqi@0	77	* @since 1.6
aoqi@0	78	*/
aoqi@0	79	@SupportedSourceVersion(RELEASE_6)
aoqi@0	80	public abstract class AbstractElementVisitor6<R, P> implements ElementVisitor<R, P> {
aoqi@0	81	/**
aoqi@0	82	* Constructor for concrete subclasses to call.
aoqi@0	83	*/
aoqi@0	84	protected AbstractElementVisitor6(){}
aoqi@0	85
aoqi@0	86	/**
aoqi@0	87	* Visits any program element as if by passing itself to that
aoqi@0	88	* element's {@link Element#accept accept} method. The invocation
aoqi@0	89	* {@code v.visit(elem)} is equivalent to {@code elem.accept(v,
aoqi@0	90	* p)}.
aoqi@0	91	*
aoqi@0	92	* @param e the element to visit
aoqi@0	93	* @param p a visitor-specified parameter
aoqi@0	94	* @return a visitor-specified result
aoqi@0	95	*/
aoqi@0	96	public final R visit(Element e, P p) {
aoqi@0	97	return e.accept(this, p);
aoqi@0	98	}
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* Visits any program element as if by passing itself to that
aoqi@0	102	* element's {@link Element#accept accept} method and passing
aoqi@0	103	* {@code null} for the additional parameter. The invocation
aoqi@0	104	* {@code v.visit(elem)} is equivalent to {@code elem.accept(v,
aoqi@0	105	* null)}.
aoqi@0	106	*
aoqi@0	107	* @param e the element to visit
aoqi@0	108	* @return a visitor-specified result
aoqi@0	109	*/
aoqi@0	110	public final R visit(Element e) {
aoqi@0	111	return e.accept(this, null);
aoqi@0	112	}
aoqi@0	113
aoqi@0	114	/**
aoqi@0	115	* {@inheritDoc}
aoqi@0	116	*
aoqi@0	117	* <p> The default implementation of this method in
aoqi@0	118	* {@code AbstractElementVisitor6} will always throw
aoqi@0	119	* {@code UnknownElementException}.
aoqi@0	120	* This behavior is not required of a subclass.
aoqi@0	121	*
aoqi@0	122	* @param e the element to visit
aoqi@0	123	* @param p a visitor-specified parameter
aoqi@0	124	* @return a visitor-specified result
aoqi@0	125	* @throws UnknownElementException
aoqi@0	126	* a visitor implementation may optionally throw this exception
aoqi@0	127	*/
aoqi@0	128	public R visitUnknown(Element e, P p) {
aoqi@0	129	throw new UnknownElementException(e, p);
aoqi@0	130	}
aoqi@0	131	}