001: /*
002: * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package javax.lang.model.element;
027:
028: import java.util.List;
029: import javax.lang.model.type.*;
030: import javax.lang.model.util.*;
031:
032: /**
033: * Represents a class or interface program element. Provides access
034: * to information about the type and its members. Note that an enum
035: * type is a kind of class and an annotation type is a kind of
036: * interface.
037: *
038: * <p> <a name="ELEM_VS_TYPE"></a>
039: * While a {@code TypeElement} represents a class or interface
040: * <i>element</i>, a {@link DeclaredType} represents a class
041: * or interface <i>type</i>, the latter being a use
042: * (or <i>invocation</i>) of the former.
043: * The distinction is most apparent with generic types,
044: * for which a single element can define a whole
045: * family of types. For example, the element
046: * {@code java.util.Set} corresponds to the parameterized types
047: * {@code java.util.Set<String>} and {@code java.util.Set<Number>}
048: * (and many others), and to the raw type {@code java.util.Set}.
049: *
050: * <p> Each method of this interface that returns a list of elements
051: * will return them in the order that is natural for the underlying
052: * source of program information. For example, if the underlying
053: * source of information is Java source code, then the elements will be
054: * returned in source code order.
055: *
056: * @author Joseph D. Darcy
057: * @author Scott Seligman
058: * @author Peter von der Ahé
059: * @version 1.14 07/05/05
060: * @see DeclaredType
061: * @since 1.6
062: */
063: public interface TypeElement extends Element {
064:
065: /**
066: * Returns the <i>nesting kind</i> of this type element.
067: *
068: * @return the nesting kind of this type element
069: */
070: NestingKind getNestingKind();
071:
072: /**
073: * Returns the fully qualified name of this type element.
074: * More precisely, it returns the <i>canonical</i> name.
075: * For local and anonymous classes, which do not have canonical names,
076: * an empty name is returned.
077: *
078: * <p>The name of a generic type does not include any reference
079: * to its formal type parameters.
080: * For example, the fully qualified name of the interface
081: * {@code java.util.Set<E>} is "{@code java.util.Set}".
082: * Nested types use "{@code .}" as a separator, as in
083: * "{@code java.util.Map.Entry}".
084: *
085: * @return the fully qualified name of this class or interface, or
086: * an empty name if none
087: *
088: * @see Elements#getBinaryName
089: * @jls3 6.7 Fully Qualified Names and Canonical Names
090: */
091: Name getQualifiedName();
092:
093: /**
094: * Returns the direct superclass of this type element.
095: * If this type element represents an interface or the class
096: * {@code java.lang.Object}, then a {@link NoType}
097: * with kind {@link TypeKind#NONE NONE} is returned.
098: *
099: * @return the direct superclass, or a {@code NoType} if there is none
100: */
101: TypeMirror getSuperclass();
102:
103: /**
104: * Returns the interface types directly implemented by this class
105: * or extended by this interface.
106: *
107: * @return the interface types directly implemented by this class
108: * or extended by this interface, or an empty list if there are none
109: */
110: List<? extends TypeMirror> getInterfaces();
111:
112: /**
113: * Returns the formal type parameters of this type element
114: * in declaration order.
115: *
116: * @return the formal type parameters, or an empty list
117: * if there are none
118: */
119: List<? extends TypeParameterElement> getTypeParameters();
120: }
|