Interface TypeElement

  • All Superinterfaces:
    javax.lang.model.AnnotatedConstruct, Element, Parameterizable, QualifiedNameable

    public interface TypeElement
    extends Element, Parameterizable, QualifiedNameable
    Represents a class or interface program element. Provides access to information about the type and its members. Note that an enum type and a record type are kinds of classes and an annotation type is a kind of interface.

    While a TypeElement represents a class or interface element, a DeclaredType represents a class or interface type, the latter being a use (or invocation) of the former. The distinction is most apparent with generic types, for which a single element can define a whole family of types. For example, the element java.util.Set corresponds to the parameterized types java.util.Set<String> and java.util.Set<Number> (and many others), and to the raw type java.util.Set.

    Each method of this interface that returns a list of elements will return them in the order that is natural for the underlying source of program information. For example, if the underlying source of information is Java source code, then the elements will be returned in source code order.

    Since:
    1.6
    See Also:
    DeclaredType
    • Method Detail

      • asType

        javax.lang.model.type.TypeMirror asType()
        Returns the type defined by this type element, returning the prototypical type for an element representing a generic type.

        A generic element defines a family of types, not just one. If this is a generic element, a prototypical type is returned which has the element's invocation on the type variables corresponding to its own formal type parameters. For example, for the generic class element C<N extends Number>, the parameterized type C<N> is returned. The Types utility interface has more general methods for obtaining the full range of types defined by an element.

        Specified by:
        asType in interface Element
        Returns:
        the type defined by this type element
        See Also:
        Types.asMemberOf(DeclaredType, Element), Types.getDeclaredType(TypeElement, TypeMirror...)
      • getNestingKind

        NestingKind getNestingKind()
        Returns the nesting kind of this type element.
        Returns:
        the nesting kind of this type element
      • getQualifiedName

        Name getQualifiedName()
        Returns the fully qualified name of this type element. More precisely, it returns the canonical name. For local and anonymous classes, which do not have canonical names, an empty name is returned.

        The name of a generic type does not include any reference to its formal type parameters. For example, the fully qualified name of the interface java.util.Set<E> is "java.util.Set". Nested types use "." as a separator, as in "java.util.Map.Entry".

        Specified by:
        getQualifiedName in interface QualifiedNameable
        Returns:
        the fully qualified name of this class or interface, or an empty name if none
        See Also:
        Elements.getBinaryName(javax.lang.model.element.TypeElement)
      • getSuperclass

        javax.lang.model.type.TypeMirror getSuperclass()
        Returns the direct superclass of this type element. If this type element represents an interface or the class java.lang.Object, then a NoType with kind NONE is returned.
        Returns:
        the direct superclass, or a NoType if there is none
      • getInterfaces

        java.util.List<? extends javax.lang.model.type.TypeMirror> getInterfaces()
        Returns the interface types directly implemented by this class or extended by this interface.
        Returns:
        the interface types directly implemented by this class or extended by this interface, or an empty list if there are none
      • getTypeParameters

        java.util.List<? extends TypeParameterElement> getTypeParameters()
        Returns the formal type parameters of this type element in declaration order.
        Specified by:
        getTypeParameters in interface Parameterizable
        Returns:
        the formal type parameters, or an empty list if there are none
      • getRecordComponents

        default java.util.List<? extends RecordComponentElement> getRecordComponents()
        Returns the record components of this type element in declaration order.
        Returns:
        the record components, or an empty list if there are none
        Since:
        14