1 /*

     2  * Copyright (c) 2003, 2018, 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 com.sun.javadoc;

    27 

    28 

    29 /**

    30  * Represents an invocation of a generic class or interface.  For example,

    31  * given the generic interface {@code List<E>}, possible invocations

    32  * include:

    33  * <pre>

    34  *      {@code List<String>}

    35  *      {@code List<T extends Number>}

    36  *      {@code List<?>}

    37  * </pre>

    38  * A generic inner class {@code Outer<T>.Inner<S>} might be invoked as:

    39  * <pre>

    40  *      {@code Outer<Number>.Inner<String>}

    41  * </pre>

    42  *

    43  * @author Scott Seligman

    44  * @since 1.5

    45  *

    46  * @deprecated

    47  *   The declarations in this package have been superseded by those

    48  *   in the package {@code jdk.javadoc.doclet}.

    49  *   For more information, see the <i>Migration Guide</i> in the documentation for that package.

    50  */

    51 @Deprecated(since="9", forRemoval=true)

    52 @SuppressWarnings("removal")

    53 public interface ParameterizedType extends Type {

    54 

    55     /**

    56      * Return the generic class or interface that declared this type.

    57      *

    58      * @return the generic class or interface that declared this type.

    59      */

    60     ClassDoc asClassDoc();

    61 

    62     /**

    63      * Return the actual type arguments of this type.

    64      * For a generic type that is nested within some other generic type

    65      * (such as {@code Outer<T>.Inner<S>}),

    66      * only the type arguments of the innermost type are included.

    67      *

    68      * @return the actual type arguments of this type.

    69      */

    70     Type[] typeArguments();

    71 

    72     /**

    73      * Return the class type that is a direct supertype of this one.

    74      * This is the superclass of this type's declaring class,

    75      * with type arguments substituted in.

    76      * Return null if this is an interface type.

    77      *

    78      * <p> For example, if this parameterized type is

    79      * {@code java.util.ArrayList<String>}, the result will be

    80      * {@code java.util.AbstractList<String>}.

    81      *

    82      * @return the class type that is a direct supertype of this one.

    83      */

    84     Type superclassType();

    85 

    86     /**

    87      * Return the interface types directly implemented by or extended by this

    88      * parameterized type.

    89      * These are the interfaces directly implemented or extended

    90      * by this type's declaring class or interface,

    91      * with type arguments substituted in.

    92      * Return an empty array if there are no interfaces.

    93      *

    94      * <p> For example, the interface extended by

    95      * {@code java.util.Set<String>} is {@code java.util.Collection<String>}.

    96      *

    97      * @return the interface types directly implemented by or extended by this

    98      * parameterized type.

    99      */

   100     Type[] interfaceTypes();

   101 

   102     /**

   103      * Return the type that contains this type as a member.

   104      * Return null is this is a top-level type.

   105      *

   106      * <p> For example, the containing type of

   107      * {@code AnInterface.Nested<Number>} is the {@code ClassDoc}

   108      * representing {@code AnInterface}, and the containing type of

   109      * {@code Outer<String>.Inner<Number>} is the

   110      * {@code ParameterizedType} representing {@code Outer<String>}.

   111      *

   112      * @return the type that contains this type as a member.

   113      */

   114     Type containingType();

   115 }