src/share/classes/com/sun/javadoc/ParameterizedType.java

Thu, 31 Aug 2017 15:17:03 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:17:03 +0800
changeset 2525
2eb010b6cb22
parent 554
9d9f26857129
parent 0
959103a6100f
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.javadoc;
aoqi@0 27
aoqi@0 28
aoqi@0 29 /**
aoqi@0 30 * Represents an invocation of a generic class or interface. For example,
aoqi@0 31 * given the generic interface {@code List<E>}, possible invocations
aoqi@0 32 * include:
aoqi@0 33 * <pre>
aoqi@0 34 * {@code List<String>}
aoqi@0 35 * {@code List<T extends Number>}
aoqi@0 36 * {@code List<?>}
aoqi@0 37 * </pre>
aoqi@0 38 * A generic inner class {@code Outer<T>.Inner<S>} might be invoked as:
aoqi@0 39 * <pre>
aoqi@0 40 * {@code Outer<Number>.Inner<String>}
aoqi@0 41 * </pre>
aoqi@0 42 *
aoqi@0 43 * @author Scott Seligman
aoqi@0 44 * @since 1.5
aoqi@0 45 */
aoqi@0 46 public interface ParameterizedType extends Type {
aoqi@0 47
aoqi@0 48 /**
aoqi@0 49 * Return the generic class or interface that declared this type.
aoqi@0 50 *
aoqi@0 51 * @return the generic class or interface that declared this type.
aoqi@0 52 */
aoqi@0 53 ClassDoc asClassDoc();
aoqi@0 54
aoqi@0 55 /**
aoqi@0 56 * Return the actual type arguments of this type.
aoqi@0 57 * For a generic type that is nested within some other generic type
aoqi@0 58 * (such as {@code Outer<T>.Inner<S>}),
aoqi@0 59 * only the type arguments of the innermost type are included.
aoqi@0 60 *
aoqi@0 61 * @return the actual type arguments of this type.
aoqi@0 62 */
aoqi@0 63 Type[] typeArguments();
aoqi@0 64
aoqi@0 65 /**
aoqi@0 66 * Return the class type that is a direct supertype of this one.
aoqi@0 67 * This is the superclass of this type's declaring class,
aoqi@0 68 * with type arguments substituted in.
aoqi@0 69 * Return null if this is an interface type.
aoqi@0 70 *
aoqi@0 71 * <p> For example, if this parameterized type is
aoqi@0 72 * {@code java.util.ArrayList<String>}, the result will be
aoqi@0 73 * {@code java.util.AbstractList<String>}.
aoqi@0 74 *
aoqi@0 75 * @return the class type that is a direct supertype of this one.
aoqi@0 76 */
aoqi@0 77 Type superclassType();
aoqi@0 78
aoqi@0 79 /**
aoqi@0 80 * Return the interface types directly implemented by or extended by this
aoqi@0 81 * parameterized type.
aoqi@0 82 * These are the interfaces directly implemented or extended
aoqi@0 83 * by this type's declaring class or interface,
aoqi@0 84 * with type arguments substituted in.
aoqi@0 85 * Return an empty array if there are no interfaces.
aoqi@0 86 *
aoqi@0 87 * <p> For example, the interface extended by
aoqi@0 88 * {@code java.util.Set<String>} is {@code java.util.Collection<String>}.
aoqi@0 89 *
aoqi@0 90 * @return the interface types directly implemented by or extended by this
aoqi@0 91 * parameterized type.
aoqi@0 92 */
aoqi@0 93 Type[] interfaceTypes();
aoqi@0 94
aoqi@0 95 /**
aoqi@0 96 * Return the type that contains this type as a member.
aoqi@0 97 * Return null is this is a top-level type.
aoqi@0 98 *
aoqi@0 99 * <p> For example, the containing type of
aoqi@0 100 * {@code AnInterface.Nested<Number>} is the <code>ClassDoc</code>
aoqi@0 101 * representing {@code AnInterface}, and the containing type of
aoqi@0 102 * {@code Outer<String>.Inner<Number>} is the
aoqi@0 103 * <code>ParameterizedType</code> representing {@code Outer<String>}.
aoqi@0 104 *
aoqi@0 105 * @return the type that contains this type as a member.
aoqi@0 106 */
aoqi@0 107 Type containingType();
aoqi@0 108 }

mercurial