1 /*
   2  * Copyright (c) 2012, 2013, 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  * @since 1.8
  37  */
  38 public interface AnnotatedType extends AnnotatedElement {
  39 
  40     /**
  41      * Returns the potentially annotated type that this type is a member of, if
  42      * this type represents a nested type. For example, if this type is
  43      * {@code @TA O<T>.I<S>}, return a representation of {@code @TA O<T>}.
  44      *
  45      * <p>Returns {@code null} if this {@code AnnotatedType} represents a
  46      *     top-level type, or a local or anonymous class, or a primitive type, or
  47      *     void.
  48      *
  49      * <p>Returns {@code null} if this {@code AnnotatedType} is an instance of
  50      *     {@code AnnotatedArrayType}, {@code AnnotatedTypeVariable}, or
  51      *     {@code AnnotatedWildcardType}.
  52      *
  53      * @implSpec
  54      * This default implementation returns {@code null} and performs no other
  55      * action.
  56      *
  57      * @return an {@code AnnotatedType} object representing the potentially
  58      *     annotated type that this type is a member of, or {@code null}
  59      * @throws TypeNotPresentException if the owner type
  60      *     refers to a non-existent type declaration
  61      * @throws MalformedParameterizedTypeException if the owner type
  62      *     refers to a parameterized type that cannot be instantiated
  63      *     for any reason
  64      *
  65      * @since 9
  66      */
  67     default AnnotatedType getAnnotatedOwnerType() {
  68         return null;
  69     }
  70 
  71     /**
  72      * Returns the underlying type that this annotated type represents.
  73      *
  74      * @return the type this annotated type represents
  75      */
  76     public Type getType();
  77 
  78     /**
  79      * {@inheritDoc}
  80      * <p>Note that any annotation returned by this method is a type
  81      * annotation.
  82      *
  83      * @throws NullPointerException {@inheritDoc}
  84      * @since 1.8
  85      */
  86     @Override
  87     <T extends Annotation> T getAnnotation(Class<T> annotationClass);
  88 
  89 }