1 /*
2 * Copyright (c) 2005, 2011, 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 javax.lang.model.element;
27
28 import java.util.List;
29 import javax.lang.model.type.*;
30 import javax.lang.model.util.*;
31
32 /**
33 * Represents a class or interface program element. Provides access
34 * to information about the type and its members. Note that an enum
35 * type is a kind of class and an annotation type is a kind of
36 * interface.
37 *
38 * <p> <a name="ELEM_VS_TYPE"></a>
39 * While a {@code TypeElement} represents a class or interface
40 * <i>element</i>, a {@link DeclaredType} represents a class
41 * or interface <i>type</i>, the latter being a use
42 * (or <i>invocation</i>) of the former.
43 * The distinction is most apparent with generic types,
44 * for which a single element can define a whole
45 * family of types. For example, the element
46 * {@code java.util.Set} corresponds to the parameterized types
47 * {@code java.util.Set<String>} and {@code java.util.Set<Number>}
48 * (and many others), and to the raw type {@code java.util.Set}.
49 *
50 * <p> Each method of this interface that returns a list of elements
51 * will return them in the order that is natural for the underlying
52 * source of program information. For example, if the underlying
53 * source of information is Java source code, then the elements will be
54 * returned in source code order.
55 *
56 * @author Joseph D. Darcy
57 * @author Scott Seligman
58 * @author Peter von der Ahé
59 * @see DeclaredType
60 * @since 1.6
61 */
62 public interface TypeElement extends Element, Parameterizable, QualifiedNameable {
63 /**
64 * {@inheritDoc}
65 *
66 * <p> Note that as a particular instance of the {@linkplain
67 * javax.lang.model.element general accuracy requirements} and the
68 * ordering behavior required of this interface, the list of
69 * enclosed elements will be returned in the natural order for the
70 * originating source of information about the type. For example,
71 * if the information about the type is originating from a source
72 * file, the elements will be returned in source code order.
73 * (However, in that case the the ordering of synthesized
74 * elements, such as a default constructor, is not specified.)
75 *
76 * @return the enclosed elements in proper order, or an empty list if none
77 */
78 List<? extends Element> getEnclosedElements();
79
80 /**
81 * Returns the <i>nesting kind</i> of this type element.
82 *
83 * @return the nesting kind of this type element
84 */
85 NestingKind getNestingKind();
86
87 /**
88 * Returns the fully qualified name of this type element.
89 * More precisely, it returns the <i>canonical</i> name.
90 * For local and anonymous classes, which do not have canonical names,
91 * an empty name is returned.
92 *
93 * <p>The name of a generic type does not include any reference
94 * to its formal type parameters.
95 * For example, the fully qualified name of the interface
96 * {@code java.util.Set<E>} is "{@code java.util.Set}".
97 * Nested types use "{@code .}" as a separator, as in
98 * "{@code java.util.Map.Entry}".
99 *
100 * @return the fully qualified name of this class or interface, or
101 * an empty name if none
102 *
103 * @see Elements#getBinaryName
104 * @jls3 6.7 Fully Qualified Names and Canonical Names
105 */
106 Name getQualifiedName();
107
108
109 /**
110 * Returns the simple name of this type element.
111 *
112 * For an anonymous class, an empty name is returned.
113 *
114 * @return the simple name of this class or interface,
115 * an empty name for an anonymous class
116 *
117 */
118 @Override
119 Name getSimpleName();
120
121 /**
122 * Returns the direct superclass of this type element.
123 * If this type element represents an interface or the class
124 * {@code java.lang.Object}, then a {@link NoType}
125 * with kind {@link TypeKind#NONE NONE} is returned.
126 *
127 * @return the direct superclass, or a {@code NoType} if there is none
128 */
129 TypeMirror getSuperclass();
130
131 /**
132 * Returns the interface types directly implemented by this class
133 * or extended by this interface.
134 *
135 * @return the interface types directly implemented by this class
136 * or extended by this interface, or an empty list if there are none
137 */
138 List<? extends TypeMirror> getInterfaces();
139
140 /**
141 * Returns the formal type parameters of this type element
142 * in declaration order.
143 *
144 * @return the formal type parameters, or an empty list
145 * if there are none
146 */
147 List<? extends TypeParameterElement> getTypeParameters();
148
149
150 /**
151 * Returns the package of a top-level type and returns the
152 * immediately lexically enclosing element for a {@linkplain
153 * NestingKind#isNested nested} type.
154 *
155 * @return the package of a top-level type, the immediately
156 * lexically enclosing element for a nested type
157 */
158 @Override
159 Element getEnclosingElement();
160 }