1 /* 2 * Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.lang.reflect; 27 28 import java.lang.annotation.Annotation; 29 30 /** 31 * {@code AnnotatedType} represents the potentially annotated use of a type in 32 * the program currently running in this VM. The use may be of any type in the 33 * Java programming language, including an array type, a parameterized type, a 34 * type variable, or a wildcard type. 35 * 36 * Note that any annotations returned by methods on this interface are 37 * <em>type annotations</em> (JLS {@jls 9.7.4}) as the entity being 38 * potentially annotated is a type. 39 * 40 * @jls 4.1 The Kinds of Types and Values 41 * @jls 4.2 Primitive Types and Values 42 * @jls 4.3 Reference Types and Values 43 * @jls 4.4 Type Variables 44 * @jls 4.5 Parameterized Types 45 * @jls 4.8 Raw Types 46 * @jls 4.9 Intersection Types 47 * @jls 10.1 Array Types 48 * @since 1.8 49 */ 50 public interface AnnotatedType extends AnnotatedElement { 51 52 /** 53 * Returns the potentially annotated type that this type is a member of, if 54 * this type represents a nested type. For example, if this type is 55 * {@code @TA O<T>.I<S>}, return a representation of {@code @TA O<T>}. 56 * 57 * <p>Returns {@code null} if this {@code AnnotatedType} represents a 58 * top-level type, or a local or anonymous class, or a primitive type, or 59 * void. 60 * 61 * <p>Returns {@code null} if this {@code AnnotatedType} is an instance of 62 * {@code AnnotatedArrayType}, {@code AnnotatedTypeVariable}, or 63 * {@code AnnotatedWildcardType}. 64 * 65 * @implSpec 66 * This default implementation returns {@code null} and performs no other 67 * action. 68 * 69 * @return an {@code AnnotatedType} object representing the potentially 70 * annotated type that this type is a member of, or {@code null} 71 * @throws TypeNotPresentException if the owner type 72 * refers to a non-existent type declaration 73 * @throws MalformedParameterizedTypeException if the owner type 74 * refers to a parameterized type that cannot be instantiated 75 * for any reason 76 * 77 * @since 9 78 */ 79 default AnnotatedType getAnnotatedOwnerType() { 80 return null; 81 } 82 83 /** 84 * Returns the underlying type that this annotated type represents. 85 * 86 * @return the type this annotated type represents 87 */ 88 public Type getType(); 89 90 /** 91 * {@inheritDoc} 92 * <p>Note that any annotation returned by this method is a type 93 * annotation. 94 * 95 * @throws NullPointerException {@inheritDoc} 96 */ 97 @Override 98 <T extends Annotation> T getAnnotation(Class<T> annotationClass); 99 100 /** 101 * {@inheritDoc} 102 * <p>Note that any annotations returned by this method are type 103 * annotations. 104 */ 105 @Override 106 Annotation[] getAnnotations(); 107 108 /** 109 * {@inheritDoc} 110 * <p>Note that any annotations returned by this method are type 111 * annotations. 112 */ 113 @Override 114 Annotation[] getDeclaredAnnotations(); 115 }