Implements javax.lang.model.element.Element.accept.

Doc from javax.lang.model.element.Element.accept.

Applies a visitor to this element.

Annotations

@Override

Implements javax.lang.model.element.Element.asType.

Doc from javax.lang.model.element.Element.asType.

Returns the type defined by this element.

Annotations

@Override

Implements javax.lang.model.element.Element.getAnnotation.

Doc from javax.lang.model.element.Element.getAnnotation.

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 that any annotation returned by this method is a declaration annotation.

Annotations

@Override

Implements javax.lang.model.element.Element.getAnnotationMirrors.

Doc from javax.lang.model.element.Element.getAnnotationMirrors.

Returns the annotations that are directly present on this construct.

To get inherited annotations as well, use getAllAnnotationMirrors.

Note that any annotations returned by this method are declaration annotations.

Annotations

@Override

Implements javax.lang.model.element.Element.getAnnotationsByType.

Doc from javax.lang.model.element.Element.getAnnotationsByType.

Returns annotations of the specified type that are associated with this construct. If there are no annotations of the specified type associated with this construct, the return value is an array of length 0. The order of annotations which are directly or indirectly present on a construct C is computed as if indirectly present annotations on C are directly present on C in place of their container annotation, in the order in which they appear in the value element of the container annotation. The difference between this method and getAnnotation(Class) is that this method detects if its argument is a repeatable annotation interface, and if so, attempts to find one or more annotations of that type by "looking through" a container annotation.

The annotations 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 that any annotations returned by this method are declaration annotations.

Annotations

@Override

Implements javax.lang.model.element.Element.getEnclosedElements.

Doc from javax.lang.model.element.Element.getEnclosedElements.

Returns the elements that are, loosely speaking, directly enclosed by this element. A class or interface is considered to enclose the fields, methods, constructors, record components, and member classes and interfaces that it directly declares. A package encloses the top-level classes and interfaces within it, but is not considered to enclose subpackages. A module encloses packages within it. Enclosed elements may include implicitly declared mandated elements. Other kinds of elements are not currently considered to enclose any elements; however, that may change as this API or the programming language evolves.

Annotations

@Override

Implements javax.lang.model.element.Element.getEnclosingElement.

Doc from javax.lang.model.element.Element.getEnclosingElement.

Returns the innermost element within which this element is, loosely speaking, enclosed.

• If this element is one whose declaration is lexically enclosed immediately within the declaration of another element, that other element is returned.
• If this is a top-level class or interface, its package is returned.
• If this is a package, its module is returned if such a module exists. Otherwise, null is returned.
• If this is a type parameter, the generic element of the type parameter is returned.
• If this is a method or constructor parameter, the executable element which declares the parameter is returned.
• If this is a record component, the record class which declares the record component is returned.
• If this is a module, null is returned.

Annotations

@Override

Returns the file object associated with this special element such as overview.html, doc-files/foo.html.

Returns:FileObject

the file object

Implements javax.lang.model.element.Element.getKind.

Doc from javax.lang.model.element.Element.getKind.

Returns the kind of this element.

• The kind of a package is PACKAGE.
• The kind of a module is MODULE.
• The kind of a type element is one of ANNOTATION_TYPE, CLASS, ENUM, INTERFACE, or RECORD.
• The kind of a variable is one of ENUM_CONSTANT, EXCEPTION_PARAMETER, FIELD, LOCAL_VARIABLE, PARAMETER, RESOURCE_VARIABLE, or BINDING_VARIABLE.
• The kind of an executable is one of CONSTRUCTOR, INSTANCE_INIT, METHOD, or STATIC_INIT.
• The kind of a type parameter is TYPE_PARAMETER.
• The kind of a record component is RECORD_COMPONENT.

Annotations

@Override

Implements javax.lang.model.element.Element.getModifiers.

Doc from javax.lang.model.element.Element.getModifiers.

Returns the modifiers of this element, excluding annotations. Implicit modifiers, such as the public and static modifiers of interface members (JLS section 9.3), are included.

Annotations

@Override

Returns the anchoring package element, in the case of a module element, this is the module's unnamed package.

Returns:PackageElement

the anchor element.

Implements javax.lang.model.element.Element.getSimpleName.

Doc from javax.lang.model.element.Element.getSimpleName.

Returns the simple (unqualified) name of this element. The name of a generic class or interface does not include any reference to its formal type parameters. For example, the simple name of the type element representing java.util.Set<E> is "Set". If this element represents an unnamed package, an unnamed module or an unnamed variable, an empty name is returned. If it represents a constructor, the name "<init>" is returned. If it represents a static initializer, the name "<clinit>" is returned. If it represents an anonymous class or instance initializer, an empty name is returned.

Annotations

@Override

Returns the subkind of this element.

Returns:DocletElement.Kind

a subkind