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

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

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

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

author

aoqi

date

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

changeset 2525

2eb010b6cb22

parent 1823

b7a10bc02e7a

parent 0

959103a6100f

permissions

-rw-r--r--

merge

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.lang.model.type.*;
aoqi@0	29	import javax.annotation.processing.SupportedSourceVersion;
aoqi@0	30	import javax.lang.model.SourceVersion;
aoqi@0	31	import static javax.lang.model.SourceVersion.*;
aoqi@0	32
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* A simple visitor of types with default behavior appropriate for the
aoqi@0	36	* {@link SourceVersion#RELEASE_6 RELEASE_6} source version.
aoqi@0	37	*
aoqi@0	38	* Visit methods corresponding to {@code RELEASE_6} language
aoqi@0	39	* constructs call {@link #defaultAction defaultAction}, passing their
aoqi@0	40	* arguments to {@code defaultAction}'s corresponding parameters.
aoqi@0	41	*
aoqi@0	42	* For constructs introduced in {@code RELEASE_7} and later, {@code
aoqi@0	43	* visitUnknown} is called instead.
aoqi@0	44	*
aoqi@0	45	* <p> Methods in this class may be overridden subject to their
aoqi@0	46	* general contract. Note that annotating methods in concrete
aoqi@0	47	* subclasses with {@link java.lang.Override @Override} will help
aoqi@0	48	* ensure that methods are overridden as intended.
aoqi@0	49	*
aoqi@0	50	* <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
aoqi@0	51	* by this class may have methods added to it in the future to
aoqi@0	52	* accommodate new, currently unknown, language structures added to
aoqi@0	53	* future versions of the Java&trade; programming language.
aoqi@0	54	* Therefore, methods whose names begin with {@code "visit"} may be
aoqi@0	55	* added to this class in the future; to avoid incompatibilities,
aoqi@0	56	* classes which extend this class should not declare any instance
aoqi@0	57	* methods with names beginning with {@code "visit"}.
aoqi@0	58	*
aoqi@0	59	* <p>When such a new visit method is added, the default
aoqi@0	60	* implementation in this class will be to call the {@link
aoqi@0	61	* #visitUnknown visitUnknown} method. A new simple type visitor
aoqi@0	62	* class will also be introduced to correspond to the new language
aoqi@0	63	* level; this visitor will have different default behavior for the
aoqi@0	64	* visit method in question. When the new visitor is introduced, all
aoqi@0	65	* or portions of this visitor may be deprecated.
aoqi@0	66	*
aoqi@0	67	* <p>Note that adding a default implementation of a new visit method
aoqi@0	68	* in a visitor class will occur instead of adding a <em>default
aoqi@0	69	* method</em> directly in the visitor interface since a Java SE 8
aoqi@0	70	* language feature cannot be used to this version of the API since
aoqi@0	71	* this version is required to be runnable on Java SE 7
aoqi@0	72	* implementations. Future versions of the API that are only required
aoqi@0	73	* to run on Java SE 8 and later may take advantage of default methods
aoqi@0	74	* in this situation.
aoqi@0	75	*
aoqi@0	76	* @param <R> the return type of this visitor's methods. Use {@link
aoqi@0	77	* Void} for visitors that do not need to return results.
aoqi@0	78	* @param <P> the type of the additional parameter to this visitor's
aoqi@0	79	* methods. Use {@code Void} for visitors that do not need an
aoqi@0	80	* additional parameter.
aoqi@0	81	*
aoqi@0	82	* @author Joseph D. Darcy
aoqi@0	83	* @author Scott Seligman
aoqi@0	84	* @author Peter von der Ah&eacute;
aoqi@0	85	*
aoqi@0	86	* @see SimpleTypeVisitor7
aoqi@0	87	* @see SimpleTypeVisitor8
aoqi@0	88	* @since 1.6
aoqi@0	89	*/
aoqi@0	90	@SupportedSourceVersion(RELEASE_6)
aoqi@0	91	public class SimpleTypeVisitor6<R, P> extends AbstractTypeVisitor6<R, P> {
aoqi@0	92	/**
aoqi@0	93	* Default value to be returned; {@link #defaultAction
aoqi@0	94	* defaultAction} returns this value unless the method is
aoqi@0	95	* overridden.
aoqi@0	96	*/
aoqi@0	97	protected final R DEFAULT_VALUE;
aoqi@0	98
aoqi@0	99	/**
aoqi@0	100	* Constructor for concrete subclasses; uses {@code null} for the
aoqi@0	101	* default value.
aoqi@0	102	*/
aoqi@0	103	protected SimpleTypeVisitor6(){
aoqi@0	104	DEFAULT_VALUE = null;
aoqi@0	105	}
aoqi@0	106
aoqi@0	107	/**
aoqi@0	108	* Constructor for concrete subclasses; uses the argument for the
aoqi@0	109	* default value.
aoqi@0	110	*
aoqi@0	111	* @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
aoqi@0	112	*/
aoqi@0	113	protected SimpleTypeVisitor6(R defaultValue){
aoqi@0	114	DEFAULT_VALUE = defaultValue;
aoqi@0	115	}
aoqi@0	116
aoqi@0	117	/**
aoqi@0	118	* The default action for visit methods. The implementation in
aoqi@0	119	* this class just returns {@link #DEFAULT_VALUE}; subclasses will
aoqi@0	120	* commonly override this method.
aoqi@0	121	*
aoqi@0	122	* @param e the type to process
aoqi@0	123	* @param p a visitor-specified parameter
aoqi@0	124	* @return {@code DEFAULT_VALUE} unless overridden
aoqi@0	125	*/
aoqi@0	126	protected R defaultAction(TypeMirror e, P p) {
aoqi@0	127	return DEFAULT_VALUE;
aoqi@0	128	}
aoqi@0	129
aoqi@0	130	/**
aoqi@0	131	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	132	*
aoqi@0	133	* @param t {@inheritDoc}
aoqi@0	134	* @param p {@inheritDoc}
aoqi@0	135	* @return the result of {@code defaultAction}
aoqi@0	136	*/
aoqi@0	137	public R visitPrimitive(PrimitiveType t, P p) {
aoqi@0	138	return defaultAction(t, p);
aoqi@0	139	}
aoqi@0	140
aoqi@0	141	/**
aoqi@0	142	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	143	*
aoqi@0	144	* @param t {@inheritDoc}
aoqi@0	145	* @param p {@inheritDoc}
aoqi@0	146	* @return the result of {@code defaultAction}
aoqi@0	147	*/
aoqi@0	148	public R visitNull(NullType t, P p){
aoqi@0	149	return defaultAction(t, p);
aoqi@0	150	}
aoqi@0	151
aoqi@0	152	/**
aoqi@0	153	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	154	*
aoqi@0	155	* @param t {@inheritDoc}
aoqi@0	156	* @param p {@inheritDoc}
aoqi@0	157	* @return the result of {@code defaultAction}
aoqi@0	158	*/
aoqi@0	159	public R visitArray(ArrayType t, P p){
aoqi@0	160	return defaultAction(t, p);
aoqi@0	161	}
aoqi@0	162
aoqi@0	163	/**
aoqi@0	164	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	165	*
aoqi@0	166	* @param t {@inheritDoc}
aoqi@0	167	* @param p {@inheritDoc}
aoqi@0	168	* @return the result of {@code defaultAction}
aoqi@0	169	*/
aoqi@0	170	public R visitDeclared(DeclaredType t, P p){
aoqi@0	171	return defaultAction(t, p);
aoqi@0	172	}
aoqi@0	173
aoqi@0	174	/**
aoqi@0	175	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	176	*
aoqi@0	177	* @param t {@inheritDoc}
aoqi@0	178	* @param p {@inheritDoc}
aoqi@0	179	* @return the result of {@code defaultAction}
aoqi@0	180	*/
aoqi@0	181	public R visitError(ErrorType t, P p){
aoqi@0	182	return defaultAction(t, p);
aoqi@0	183	}
aoqi@0	184
aoqi@0	185	/**
aoqi@0	186	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	187	*
aoqi@0	188	* @param t {@inheritDoc}
aoqi@0	189	* @param p {@inheritDoc}
aoqi@0	190	* @return the result of {@code defaultAction}
aoqi@0	191	*/
aoqi@0	192	public R visitTypeVariable(TypeVariable t, P p){
aoqi@0	193	return defaultAction(t, p);
aoqi@0	194	}
aoqi@0	195
aoqi@0	196	/**
aoqi@0	197	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	198	*
aoqi@0	199	* @param t {@inheritDoc}
aoqi@0	200	* @param p {@inheritDoc}
aoqi@0	201	* @return the result of {@code defaultAction}
aoqi@0	202	*/
aoqi@0	203	public R visitWildcard(WildcardType t, P p){
aoqi@0	204	return defaultAction(t, p);
aoqi@0	205	}
aoqi@0	206
aoqi@0	207	/**
aoqi@0	208	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	209	*
aoqi@0	210	* @param t {@inheritDoc}
aoqi@0	211	* @param p {@inheritDoc}
aoqi@0	212	* @return the result of {@code defaultAction}
aoqi@0	213	*/
aoqi@0	214	public R visitExecutable(ExecutableType t, P p) {
aoqi@0	215	return defaultAction(t, p);
aoqi@0	216	}
aoqi@0	217
aoqi@0	218	/**
aoqi@0	219	* {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0	220	*
aoqi@0	221	* @param t {@inheritDoc}
aoqi@0	222	* @param p {@inheritDoc}
aoqi@0	223	* @return the result of {@code defaultAction}
aoqi@0	224	*/
aoqi@0	225	public R visitNoType(NoType t, P p){
aoqi@0	226	return defaultAction(t, p);
aoqi@0	227	}
aoqi@0	228	}