Tue, 22 Oct 2013 17:42:10 -0700
8027119: Cleanup javadoc comments for taglet API
Reviewed-by: mduigou
1 /*
2 * Copyright (c) 2003, 2004, 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 */
26 package com.sun.javadoc;
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 public interface ParameterizedType extends Type {
48 /**
49 * Return the generic class or interface that declared this type.
50 *
51 * @return the generic class or interface that declared this type.
52 */
53 ClassDoc asClassDoc();
55 /**
56 * Return the actual type arguments of this type.
57 * For a generic type that is nested within some other generic type
58 * (such as {@code Outer<T>.Inner<S>}),
59 * only the type arguments of the innermost type are included.
60 *
61 * @return the actual type arguments of this type.
62 */
63 Type[] typeArguments();
65 /**
66 * Return the class type that is a direct supertype of this one.
67 * This is the superclass of this type's declaring class,
68 * with type arguments substituted in.
69 * Return null if this is an interface type.
70 *
71 * <p> For example, if this parameterized type is
72 * {@code java.util.ArrayList<String>}, the result will be
73 * {@code java.util.AbstractList<String>}.
74 *
75 * @return the class type that is a direct supertype of this one.
76 */
77 Type superclassType();
79 /**
80 * Return the interface types directly implemented by or extended by this
81 * parameterized type.
82 * These are the interfaces directly implemented or extended
83 * by this type's declaring class or interface,
84 * with type arguments substituted in.
85 * Return an empty array if there are no interfaces.
86 *
87 * <p> For example, the interface extended by
88 * {@code java.util.Set<String>} is {@code java.util.Collection<String>}.
89 *
90 * @return the interface types directly implemented by or extended by this
91 * parameterized type.
92 */
93 Type[] interfaceTypes();
95 /**
96 * Return the type that contains this type as a member.
97 * Return null is this is a top-level type.
98 *
99 * <p> For example, the containing type of
100 * {@code AnInterface.Nested<Number>} is the <code>ClassDoc</code>
101 * representing {@code AnInterface}, and the containing type of
102 * {@code Outer<String>.Inner<Number>} is the
103 * <code>ParameterizedType</code> representing {@code Outer<String>}.
104 *
105 * @return the type that contains this type as a member.
106 */
107 Type containingType();
108 }