diff options
Diffstat (limited to 'javax/lang/model/util/SimpleTypeVisitor6.java')
| -rw-r--r-- | javax/lang/model/util/SimpleTypeVisitor6.java | 257 |
1 files changed, 257 insertions, 0 deletions
diff --git a/javax/lang/model/util/SimpleTypeVisitor6.java b/javax/lang/model/util/SimpleTypeVisitor6.java new file mode 100644 index 000000000..c41c77ece --- /dev/null +++ b/javax/lang/model/util/SimpleTypeVisitor6.java @@ -0,0 +1,257 @@ +/* SimpleTypeVisitor6.java -- A simple visitor implementation for 1.6. + Copyright (C) 2015 Free Software Foundation, Inc. + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301 USA. + +Linking this library statically or dynamically with other modules is +making a combined work based on this library. Thus, the terms and +conditions of the GNU General Public License cover the whole +combination. + +As a special exception, the copyright holders of this library give you +permission to link this library with independent modules to produce an +executable, regardless of the license terms of these independent +modules, and to copy and distribute the resulting executable under +terms of your choice, provided that you also meet, for each linked +independent module, the terms and conditions of the license of that +module. An independent module is a module which is not derived from +or based on this library. If you modify this library, you may extend +this exception to your version of the library, but you are not +obligated to do so. If you do not wish to do so, delete this +exception statement from your version. */ + +package javax.lang.model.util; + +import javax.annotation.processing.SupportedSourceVersion; + +import javax.lang.model.SourceVersion; +import javax.lang.model.type.ArrayType; +import javax.lang.model.type.DeclaredType; +import javax.lang.model.type.ErrorType; +import javax.lang.model.type.ExecutableType; +import javax.lang.model.type.NoType; +import javax.lang.model.type.NullType; +import javax.lang.model.type.PrimitiveType; +import javax.lang.model.type.WildcardType; +import javax.lang.model.type.TypeMirror; +import javax.lang.model.type.TypeVariable; + +/** + * <p>A simple implementation of {@link TypeVisitor} for the + * 1.6 version of the Java programming language + * ({@link SourceVersion#RELEASE_6}). Each {@code visitXYZ} method + * redirects to {@code defaultAction(type, parameter)}. + * Implementors may extend this class and provide alternative + * implementations of {@link #defaultAction(TypeMirror, P)} and + * the {@code visitXYZ} methods as appropriate.</p> + * <p>As the interface this class implements may be extended in future, + * in order to support later language versions, methods beginning with + * the phrase {@code "visit"} should be avoided in subclasses. This + * class itself will be extended to direct these new methods to the + * {@link #visitUnknown(TypeMirror,P)} method and a new class will be + * added to provide implementations for the new language version. + * At this time, all or some of this class may be deprecated.</p> + * + * @param <R> the return type of the visitor's methods. {@code Void} + * can be used where there is no return value. + * @param <P> the type of the additional parameter supplied to the visitor's + * methods. + * + * @author Andrew John Hughes (gnu_andrew@member.fsf.org) + * @since 1.6 + */ +@SupportedSourceVersion(SourceVersion.RELEASE_6) +public class SimpleTypeVisitor6<R,P> extends AbstractTypeVisitor6<R,P> +{ + + /** + * The default value returned by calls to {@link #defaultAction(TypeMirror, P)}. + */ + protected final R DEFAULT_VALUE; + + /** + * Constructs a new {@link SimpleAnnotationValueVisitor6} with a {@code null} + * default value. + */ + protected SimpleTypeVisitor6() + { + this(null); + } + + /** + * Constructs a new {@link SimpleTypeVisitor6} with the specified + * default value. + * + * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}. + */ + protected SimpleTypeVisitor6(R defaultValue) + { + DEFAULT_VALUE = defaultValue; + } + + /** + * The default action for all visitor methods. The default implementation + * simply returns {@link #DEFAULT_VALUE}. + * + * @param type the type to act upon. + * @param parameter the optional parameter supplied to the visitor. + * @return {@link #DEFAULT_VALUE}. + */ + protected R defaultAction(TypeMirror type, P parameter) + { + return DEFAULT_VALUE; + } + + /** + * Visits a primitive type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the primitive type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitPrimitive(PrimitiveType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits a null type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the null type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitNull(NullType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits an array type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the array type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitArray(ArrayType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits a declared type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the declared type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitDeclared(DeclaredType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits an error type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the error type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitError(ErrorType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits a type variable. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the type variable to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitTypeVariable(TypeVariable type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits a wildcard type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the wildcard type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitWildcard(WildcardType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits an executable type. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the executable type to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitExecutable(ExecutableType type, P parameter) + { + return defaultAction(type, parameter); + } + + /** + * Visits a NoType instance. This implementation simply + * calls {@code defaultAction(type, parameter)}. + * + * @param type the NoType instance to visit. + * @param parameter the additional parameter, specific to the visitor. + * May be {@code null}. + * @return the result of {@code defaultAction(type, parameter)}. + */ + @Override + public R visitNoType(NoType type, P parameter) + { + return defaultAction(type, parameter); + } + +} + + |