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 */ 25 26 package com.sun.javadoc; 27 28 29 import com.google.doclava.annotation.Unused; 30 import com.google.doclava.annotation.Used; 31 32 /** 33 * Represents an invocation of a generic class or interface. For example, 34 * given the generic interface {@code List<E>}, possible invocations 35 * include: 36 * <pre> 37 * {@code List<String>} 38 * {@code List<T extends Number>} 39 * {@code List<?>} 40 * </pre> 41 * A generic inner class {@code Outer<T>.Inner<S>} might be invoked as: 42 * <pre> 43 * {@code Outer<Number>.Inner<String>} 44 * </pre> 45 * 46 * @author Scott Seligman 47 * @since 1.5 48 */ 49 public interface ParameterizedType extends Type { 50 51 /** 52 * Return the generic class or interface that declared this type. 53 * 54 * @return the generic class or interface that declared this type. 55 */ 56 @Unused asClassDoc()57 ClassDoc asClassDoc(); 58 59 /** 60 * Return the actual type arguments of this type. 61 * For a generic type that is nested within some other generic type 62 * (such as {@code Outer<T>.Inner<S>}), 63 * only the type arguments of the innermost type are included. 64 * 65 * @return the actual type arguments of this type. 66 */ 67 @Used typeArguments()68 Type[] typeArguments(); 69 70 /** 71 * Return the class type that is a direct supertype of this one. 72 * This is the superclass of this type's declaring class, 73 * with type arguments substituted in. 74 * Return null if this is an interface type. 75 * 76 * <p> For example, if this parameterized type is 77 * {@code java.util.ArrayList<String>}, the result will be 78 * {@code java.util.AbstractList<String>}. 79 * 80 * @return the class type that is a direct supertype of this one. 81 */ 82 @Unused superclassType()83 Type superclassType(); 84 85 /** 86 * Return the interface types directly implemented by or extended by this 87 * parameterized type. 88 * These are the interfaces directly implemented or extended 89 * by this type's declaring class or interface, 90 * with type arguments substituted in. 91 * Return an empty array if there are no interfaces. 92 * 93 * <p> For example, the interface extended by 94 * {@code java.util.Set<String>} is {@code java.util.Collection<String>}. 95 * 96 * @return the interface types directly implemented by or extended by this 97 * parameterized type. 98 */ 99 @Unused interfaceTypes()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</code> 108 * representing {@code AnInterface}, and the containing type of 109 * {@code Outer<String>.Inner<Number>} is the 110 * <code>ParameterizedType</code> representing {@code Outer<String>}. 111 * 112 * @return the type that contains this type as a member. 113 */ 114 @Unused containingType()115 Type containingType(); 116 } 117