public Class JavacElements

Implements javax.lang.model.util.Elements.getAllAnnotationMirrors.

Returns all annotations of an element, whether inherited or directly present.

Parameters

e:Element

the element being examined

Returns:List<Attribute.Compound>

all annotations of the element

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getAllMembers.

Doc from javax.lang.model.util.Elements.getAllMembers.

Returns all members of a type element, whether inherited or declared directly. For a class, the result also includes its constructors, but not local or anonymous classes.

Annotations

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getAllModuleElements.

Doc from javax.lang.model.util.Elements.getAllModuleElements.

Returns all module elements in the current environment. If no modules are present, an empty set is returned. One situation where no modules are present occurs when the environment does not include modules, such as an annotation processing environment configured for a source version without modules.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getBinaryName.

Doc from javax.lang.model.util.Elements.getBinaryName.

Returns the binary name of a type element.

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getConstantExpression.

Doc from javax.lang.model.util.Elements.getConstantExpression.

Returns the text of a constant expression representing a primitive value or a string. The text returned is in a form suitable for representing the value in source code.

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getDocComment.

Doc from javax.lang.model.util.Elements.getDocComment.

Returns the text of the documentation ("JavaDoc") comment of an element.

A documentation comment of an element is a particular kind of comment that immediately precedes the element, ignoring white space, annotations and any other comments that are not themselves documentation comments.

There are two kinds of documentation comments, either based on traditional comments or based on a series of end-of-line comments. For both kinds, the text returned for the documentation comment is a processed form of the comment as it appears in source code, as described below.

A traditional documentation comment is a traditional comment that begins with "/**", and ends with a separate "*/". (Therefore, such a comment contains at least three "*" characters.) The lines of such a comment are processed as follows:

• The leading "/**" is removed, as are any immediately following space characters on that line. If all the characters of the line are removed, it makes no contribution to the returned comment.
• For subsequent lines of the doc comment starting after the initial "/**", if the lines start with zero or more whitespace characters followed by one or more "*" characters, those leading whitespace characters are discarded as are any consecutive "*" characters appearing after the white space or starting the line. Otherwise, if a line does not have a prefix of the described form, the entire line is retained.
• The trailing "*/" is removed. The line with the trailing" */" also undergoes leading space and "*" character removal as described above.
• The processed lines are then concatenated together, separated by newline ("\n") characters, and returned.

An end-of-line documentation comment is a series of adjacent end-of-line comments, each on a line by itself, ignoring any whitespace characters at the beginning of the line, and each beginning with "///". The lines of such a comment are processed as follows:

• Any leading whitespace and the three initial "/" characters are removed from each line.
• The lines are shifted left, by removing leading whitespace characters, until the non-blank line with the least leading whitespace characters has no remaining leading whitespace characters.
• Additional leading whitespace characters and any trailing whitespace characters in each line are preserved.
• The processed lines are then concatenated together, separated by newline ("\n") characters, and returned. If the last line is not blank, the returned value will not be terminated by a newline character.

Annotations

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getDocCommentKind.

Doc from javax.lang.model.util.Elements.getDocCommentKind.

Returns the kind of the documentation comment for the given element, or null if there is no comment or the kind is not known.

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getElementValuesWithDefaults.

Doc from javax.lang.model.util.Elements.getElementValuesWithDefaults.

Returns the values of an annotation's elements, including defaults.

Annotations

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getEnumConstantBody.

Doc from javax.lang.model.util.Elements.getEnumConstantBody.

Returns the class body of an enum constant if the argument is an enum constant declared with an optional class body, null otherwise.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getFileObjectOf.

Doc from javax.lang.model.util.Elements.getFileObjectOf.

Returns the file object for this element or null if there is no such file object.

The returned file object is for the reference representation of the information used to construct the element. For example, if during compilation or annotation processing, a source file for class Foo is compiled into a class file, the file object returned for the element representing Foo would be for the source file and not for the class file.

An implementation may choose to not support the functionality of this method, in which case UnsupportedOperationException is thrown.

In the context of annotation processing, a non-null value is returned if the element was included as part of the initial inputs or the containing file was created during the run of the annotation processing tool. Otherwise, a null may be returned. In annotation processing, if a class file is created, that class file can serve as the reference representation for elements.

If it has a file object, the file object for a package will be a package-info file. A package may exist and not have any package-info file even if the package is (implicitly) created during an annotation processing run from the creation of source or class files in that package. An unnamed package will have a null file since it cannot be declared in a compilation unit.

If it has a file object, the file object for a module will be a module-info file. An unnamed module will have a null file since it cannot be declared in a compilation unit. An automatic module will have a null file since it is implicitly declared.

If it has a file object, the file object for a top-level public class or interface will be a source or class file corresponding to that class or interface. In this case, typically the leading portion of the name of the file will match the name of the class or interface. A single compilation unit can define multiple top-level classes and interfaces, such as a primary public class or interfaces whose name corresponds to the file name and one or more auxiliary classes or interfaces whose names do not correspond to the file name. If a source file is providing the reference representation of an auxiliary class or interface, the file for the primary class is returned. (An auxiliary class or interface can also be defined in a package-info source file, in which case the file for the package-info file is returned.) If a class file is providing the reference representation of an auxiliary class or interface, the separate class file for the auxiliary class is returned.

For a nested class or interface, if it has a file object:

• if a source file is providing the reference representation, the file object will be that of the outermost enclosing class or interface
• if a class file is providing the reference representation, the file object will be that of the nested class or interface itself

For other lexically enclosed elements, such as variables, methods, and constructors, if they have a file object, the file object will be the object associated with the enclosing element of the lexically enclosed element.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getModuleElement.

Doc from javax.lang.model.util.Elements.getModuleElement.

Returns a module element given its fully qualified name. If the requested module cannot be found, null is returned. One situation where a module cannot be found is if the environment does not include modules, such as an annotation processing environment configured for a source version without modules.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getModuleOf.

Doc from javax.lang.model.util.Elements.getModuleOf.

Returns the module of an element. The module of a module is itself. If a package has a module as its enclosing element, that module is the module of the package. If the enclosing element of a package is null, null is returned for the package's module. (One situation where a package may have a null module is if the environment does not include modules, such as an annotation processing environment configured for a source version without modules.) Otherwise, the module of an element is equal to the module of the package of the element.

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getName.

Doc from javax.lang.model.util.Elements.getName.

Returns a name with the same sequence of characters as the argument.

Annotations

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getOrigin.

Doc from javax.lang.model.util.Elements.getOrigin.

Returns the origin of the given element.

Note that if this method returns EXPLICIT and the element was created from a class file, then the element may not, in fact, correspond to an explicitly declared construct in source code. This is due to limitations of the fidelity of the class file format in preserving information from source code. For example, at least some versions of the class file format do not preserve whether a constructor was explicitly declared by the programmer or was implicitly declared as the default constructor.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getOrigin.

Doc from javax.lang.model.util.Elements.getOrigin.

Returns the origin of the given annotation mirror. An annotation mirror is mandated if it is an implicitly declared container annotation used to hold repeated annotations of a repeatable annotation interface.

Note that if this method returns EXPLICIT and the annotation mirror was created from a class file, then the element may not, in fact, correspond to an explicitly declared construct in source code. This is due to limitations of the fidelity of the class file format in preserving information from source code. For example, at least some versions of the class file format do not preserve whether an annotation was explicitly declared by the programmer or was implicitly declared as a container annotation.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getOrigin.

Doc from javax.lang.model.util.Elements.getOrigin.

Returns the origin of the given module directive.

Note that if this method returns EXPLICIT and the module directive was created from a class file, then the module directive may not, in fact, correspond to an explicitly declared construct in source code. This is due to limitations of the fidelity of the class file format in preserving information from source code. For example, at least some versions of the class file format do not preserve whether a uses directive was explicitly declared by the programmer or was added as a synthetic construct.

Note that an implementation may not be able to reliably determine the origin status of the directive if the directive is created from a class file due to limitations of the fidelity of the class file format in preserving information from source code.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getOutermostTypeElement.

Doc from javax.lang.model.util.Elements.getOutermostTypeElement.

Returns the outermost type element an element is contained in if such a containing element exists; otherwise returns null. Modules and packages do not have a containing type element and therefore null is returned for those kinds of elements. A top-level class or interface is its own outermost type element.

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getPackageElement.

Doc from javax.lang.model.util.Elements.getPackageElement.

Returns a package given its fully qualified name if the package is uniquely determinable in the environment. If running with modules, packages of the given name are searched in a two-stage process:

• find non-empty packages with the given name returned by getPackageElement(ModuleElement, CharSequence), where the provided ModuleElement is any root module,
• if the above yields an empty list, search all modules for observable packages with the given name

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getPackageElement.

Doc from javax.lang.model.util.Elements.getPackageElement.

Returns a package given its fully qualified name, as seen from the given module.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.getPackageOf.

Doc from javax.lang.model.util.Elements.getPackageOf.

Returns the package of an element. The package of a package is itself. The package of a module is null. The package of a top-level class or interface is its enclosing package. Otherwise, the package of an element is equal to the package of the enclosing element.

Annotations

@DefinedBy:LANGUAGE_MODEL

Returns the tree node corresponding to this element, or null if none can be found.

Returns the best approximation for the tree node and compilation unit corresponding to the given element, annotation and value. If the element is null, null is returned. If the annotation is null or cannot be found, the tree node and compilation unit for the element is returned. If the annotation value is null or cannot be found, the tree node and compilation unit for the annotation is returned.

Implements javax.lang.model.util.Elements.getTypeElement.

Doc from javax.lang.model.util.Elements.getTypeElement.

Returns a type element given its canonical name if the type element is uniquely determinable in the environment. If running with modules, type elements of the given name are searched in a two-stage process:

• find type elements with the given name returned by getTypeElement(ModuleElement, CharSequence), where the provided ModuleElement is any root module,
• if the above yields an empty list, search all modules for observable type elements with the given name

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.getTypeElement.

Doc from javax.lang.model.util.Elements.getTypeElement.

Returns a type element given its canonical name, as seen from the given module.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.hides.

Doc from javax.lang.model.util.Elements.hides.

Tests whether one type, method, or field hides another.

Annotations

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.isAutomaticModule.

Doc from javax.lang.model.util.Elements.isAutomaticModule.

Returns true if the module element is an automatic module, false otherwise.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.isCanonicalConstructor.

Doc from javax.lang.model.util.Elements.isCanonicalConstructor.

Returns true if the executable element can be determined to be a canonical constructor of a record, false otherwise. Note that in some cases there may be insufficient information to determine if a constructor is a canonical constructor, such as if the executable element is built backed by a class file. In such cases, false is returned.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Overrides default javax.lang.model.util.Elements.isCompactConstructor.

Doc from javax.lang.model.util.Elements.isCompactConstructor.

Returns true if the executable element can be determined to be a compact constructor of a record, false otherwise. By definition, a compact constructor is also a canonical constructor. Note that in some cases there may be insufficient information to determine if a constructor is a compact constructor, such as if the executable element is built backed by a class file. In such cases, false is returned.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.isDeprecated.

Doc from javax.lang.model.util.Elements.isDeprecated.

Returns true if the element is deprecated, false otherwise.

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.isFunctionalInterface.

Doc from javax.lang.model.util.Elements.isFunctionalInterface.

Returns true if the type element is a functional interface, false otherwise.

Annotations

@Override

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.overrides.

Doc from javax.lang.model.util.Elements.overrides.

Tests whether one method, as a member of a given class or interface, overrides another method. When a non-abstract method overrides an abstract one, the former is also said to implement the latter. As implied by JLS 8.4.8.1, a method does not override itself. The overrides relation is irreflexive.

In the simplest and most typical usage, the value of the type parameter will simply be the class or interface directly enclosing overrider (the possibly-overriding method). For example, suppose m1 represents the method String.hashCode and m2 represents Object.hashCode. We can then ask whether m1 overrides m2 within the class String (it does):

assert elements.overrides(m1, m2, elements.getTypeElement("java.lang.String"));

class A { public void m() {} }
interface B { void m(); }
...
m1 = ...; // A.m
m2 = ...; // B.m
assert ! elements.overrides(m1, m2, elements.getTypeElement("A"));

class C extends A implements B {}
...
assert elements.overrides(m1, m2, elements.getTypeElement("C"));

interface I {
  @Override
  String toString();
}
...
assert elements.overrides(elementForItoString,
                          elementForObjecttoString,
                          elements.getTypeElement("I"));

Annotations

@DefinedBy:LANGUAGE_MODEL

Implements javax.lang.model.util.Elements.printElements.

Print a representation of the elements to the given writer in the specified order. The main purpose of this method is for diagnostics. The exact format of the output is not specified and is subject to change.

Parameters

w:Writer

the writer to print the output to

elements:Element[]

the elements to print

Annotations

@DefinedBy:LANGUAGE_MODEL