Interface Element

    • Method Detail

      • asType

        TypeMirror asType()
        Returns the type defined by this element.

        A generic element defines a family of types, not just one. If this is a generic element, a prototypical type is returned. This is 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.

        the type defined by this element
        See Also:
      • getKind

        ElementKind getKind()
        Returns the kind of this element.
        the kind of this element
      • getModifiers

        Set<Modifier> getModifiers()
        Returns the modifiers of this element, excluding annotations. Implicit modifiers, such as the public and static modifiers of interface members, are included.
        the modifiers of this element, or an empty set if there are none
      • equals

        boolean equals​(Object obj)
        Returns true if the argument represents the same element as this, or false otherwise.
        equals in class Object
        API Note:
        The identity of an element involves implicit state not directly accessible from the element's methods, including state about the presence of unrelated types. Element objects created by different implementations of these interfaces should not be expected to be equal even if "the same" element is being modeled; this is analogous to the inequality of Class objects for the same class file loaded through different class loaders.
        obj - the object to be compared with this element
        true if the specified object represents the same element as this
        See Also:
        Object.hashCode(), HashMap
      • getAnnotation

        <A extends Annotation> A getAnnotation​(Class<A> annotationType)
        Returns this construct's annotation of the specified type if such an annotation is present, else null.

        The annotation returned by this method could contain an element whose value is of type Class. This value cannot be returned directly: information necessary to locate and load a class (such as the class loader to use) is not available, and the class might not be loadable at all. Attempting to read a Class object by invoking the relevant method on the returned annotation will result in a MirroredTypeException, from which the corresponding TypeMirror may be extracted. Similarly, attempting to read a Class[]-valued element will result in a MirroredTypesException.

        Note: This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation types currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation types.

        Specified by:
        getAnnotation in interface AnnotatedConstruct
        Type Parameters:
        A - the annotation type
        annotationType - the Class object corresponding to the annotation type
        this construct's annotation for the specified annotation type if present, else null
        See Also:
        AnnotatedConstruct.getAnnotationMirrors(), AnnotatedElement.getAnnotation(java.lang.Class<T>), EnumConstantNotPresentException, AnnotationTypeMismatchException, IncompleteAnnotationException, MirroredTypeException, MirroredTypesException
      • accept

        <R,​P> R accept​(ElementVisitor<R,​P> v,
                             P p)
        Applies a visitor to this element.
        Type Parameters:
        R - the return type of the visitor's methods
        P - the type of the additional parameter to the visitor's methods
        v - the visitor operating on this element
        p - additional parameter to the visitor
        a visitor-specified result