01 /*
02 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.lang.model.type;
27
28 import java.util.List;
29
30 import javax.lang.model.element.Element;
31 import javax.lang.model.element.TypeElement;
32 import javax.lang.model.util.Types;
33
34 /**
35 * Represents a declared type, either a class type or an interface type.
36 * This includes parameterized types such as {@code java.util.Set<String>}
37 * as well as raw types.
38 *
39 * <p> While a {@code TypeElement} represents a class or interface
40 * <i>element</i>, a {@code DeclaredType} represents a class
41 * or interface <i>type</i>, the latter being a use
42 * (or <i>invocation</i>) of the former.
43 * See {@link TypeElement} for more on this distinction.
44 *
45 * <p> The supertypes (both class and interface types) of a declared
46 * type may be found using the {@link
47 * Types#directSupertypes(TypeMirror)} method. This returns the
48 * supertypes with any type arguments substituted in.
49 *
50 * <p> This interface is also used to represent intersection types.
51 * An intersection type is implicit in a program rather than being
52 * explictly declared. For example, the bound of the type parameter
53 * {@code <T extends Number & Runnable>}
54 * is an intersection type. It is represented by a {@code DeclaredType}
55 * with {@code Number} as its superclass and {@code Runnable} as its
56 * lone superinterface.
57 *
58 * @author Joseph D. Darcy
59 * @author Scott Seligman
60 * @author Peter von der Ahé
61 * @version 1.12 07/05/05
62 * @see TypeElement
63 * @since 1.6
64 */
65 public interface DeclaredType extends ReferenceType {
66
67 /**
68 * Returns the element corresponding to this type.
69 *
70 * @return the element corresponding to this type
71 */
72 Element asElement();
73
74 /**
75 * Returns the type of the innermost enclosing instance or a
76 * {@code NoType} of kind {@code NONE} if there is no enclosing
77 * instance. Only types corresponding to inner classes have an
78 * enclosing instance.
79 *
80 * @return a type mirror for the enclosing type
81 * @jls3 8.1.3 Inner Classes and Enclosing Instances
82 * @jls3 15.9.2 Determining Enclosing Instances
83 */
84 TypeMirror getEnclosingType();
85
86 /**
87 * Returns the actual type arguments of this type.
88 * For a type nested within a parameterized type
89 * (such as {@code Outer<String>.Inner<Number>}), only the type
90 * arguments of the innermost type are included.
91 *
92 * @return the actual type arguments of this type, or an empty list
93 * if none
94 */
95 List<? extends TypeMirror> getTypeArguments();
96 }
|