/*
* Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.javadoc;
Represents an invocation of a generic class or interface. For example, given the generic interface List<E>, possible invocations include: List<String> List<T extends Number> List<?>
A generic inner class Outer<T>.Inner<S> might be invoked as: Outer<Number>.Inner<String>
Author: Scott Seligman Since: 1.5 Deprecated: The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
/**
* Represents an invocation of a generic class or interface. For example,
* given the generic interface {@code List<E>}, possible invocations
* include:
* <pre>
* {@code List<String>}
* {@code List<T extends Number>}
* {@code List<?>}
* </pre>
* A generic inner class {@code Outer<T>.Inner<S>} might be invoked as:
* <pre>
* {@code Outer<Number>.Inner<String>}
* </pre>
*
* @author Scott Seligman
* @since 1.5
*
* @deprecated
* The declarations in this package have been superseded by those
* in the package {@code jdk.javadoc.doclet}.
* For more information, see the <i>Migration Guide</i> in the documentation for that package.
*/
@Deprecated(since="9", forRemoval=true)
@SuppressWarnings("removal")
public interface ParameterizedType extends Type {
Return the generic class or interface that declared this type.
Returns: the generic class or interface that declared this type.
/**
* Return the generic class or interface that declared this type.
*
* @return the generic class or interface that declared this type.
*/
ClassDoc asClassDoc();
Return the actual type arguments of this type. For a generic type that is nested within some other generic type (such as Outer<T>.Inner<S>), only the type arguments of the innermost type are included. Returns: the actual type arguments of this type.
/**
* Return the actual type arguments of this type.
* For a generic type that is nested within some other generic type
* (such as {@code Outer<T>.Inner<S>}),
* only the type arguments of the innermost type are included.
*
* @return the actual type arguments of this type.
*/
Type[] typeArguments();
Return the class type that is a direct supertype of this one.
This is the superclass of this type's declaring class,
with type arguments substituted in.
Return null if this is an interface type.
For example, if this parameterized type is java.util.ArrayList<String>, the result will be java.util.AbstractList<String>.
Returns: the class type that is a direct supertype of this one.
/**
* Return the class type that is a direct supertype of this one.
* This is the superclass of this type's declaring class,
* with type arguments substituted in.
* Return null if this is an interface type.
*
* <p> For example, if this parameterized type is
* {@code java.util.ArrayList<String>}, the result will be
* {@code java.util.AbstractList<String>}.
*
* @return the class type that is a direct supertype of this one.
*/
Type superclassType();
Return the interface types directly implemented by or extended by this
parameterized type.
These are the interfaces directly implemented or extended
by this type's declaring class or interface,
with type arguments substituted in.
Return an empty array if there are no interfaces.
For example, the interface extended by java.util.Set<String> is java.util.Collection<String>.
Returns: the interface types directly implemented by or extended by this
parameterized type.
/**
* Return the interface types directly implemented by or extended by this
* parameterized type.
* These are the interfaces directly implemented or extended
* by this type's declaring class or interface,
* with type arguments substituted in.
* Return an empty array if there are no interfaces.
*
* <p> For example, the interface extended by
* {@code java.util.Set<String>} is {@code java.util.Collection<String>}.
*
* @return the interface types directly implemented by or extended by this
* parameterized type.
*/
Type[] interfaceTypes();
Return the type that contains this type as a member.
Return null is this is a top-level type.
For example, the containing type of AnInterface.Nested<Number> is the ClassDoc representing AnInterface, and the containing type of Outer<String>.Inner<Number> is the ParameterizedType representing Outer<String>.
Returns: the type that contains this type as a member.
/**
* Return the type that contains this type as a member.
* Return null is this is a top-level type.
*
* <p> For example, the containing type of
* {@code AnInterface.Nested<Number>} is the {@code ClassDoc}
* representing {@code AnInterface}, and the containing type of
* {@code Outer<String>.Inner<Number>} is the
* {@code ParameterizedType} representing {@code Outer<String>}.
*
* @return the type that contains this type as a member.
*/
Type containingType();
}