Please note that the specifications and other information contained herein are not final and are subject to change. The information is being made available to you solely for purpose of evaluation.

Java™ Platform
Standard Ed. 7

DRAFT ea-b118

Package javax.lang.model.element

Interfaces used to model elements of the Java programming language.


Interface Summary
Interface Description
AnnotationMirror Represents an annotation.
AnnotationValue Represents a value of an annotation type element.
AnnotationValueVisitor<R,P> A visitor of the values of annotation type elements, using a variant of the visitor design pattern.
Element Represents a program element such as a package, class, or method.
ElementVisitor<R,P> A visitor of program elements, in the style of the visitor design pattern.
ExecutableElement Represents a method, constructor, or initializer (static or instance) of a class or interface, including annotation type elements.
Name An immutable sequence of characters.
PackageElement Represents a package program element.
Parameterizable A mixin interface for an element that has type parameters.
QualifiedNameable A mixin interface for an element that has a qualified name.
TypeElement Represents a class or interface program element.
TypeParameterElement Represents a formal type parameter of a generic class, interface, method, or constructor element.
VariableElement Represents a field, enum constant, method or constructor parameter, local variable, or exception parameter.

Enum Summary
Enum Description
ElementKind The kind of an element.
Modifier Represents a modifier on a program element such as a class, method, or field.
NestingKind The nesting kind of a type element.

Exception Summary
Exception Description
UnknownAnnotationValueException Indicates that an unknown kind of annotation value was encountered.
UnknownElementException Indicates that an unknown kind of element was encountered.

Package javax.lang.model.element Description

Interfaces used to model elements of the Java programming language. The term "element" in this package is used to refer to program elements, the declared entities that make up a program. Elements include classes, interfaces, methods, constructors, and fields. The interfaces in this package do not model the structure of a program inside a method body; for example there is no representation of a for loop or try-finally block. However, the interfaces can model some structures only appearing inside method bodies, such as local variables and anonymous classes.

When used in the context of annotation processing, an accurate model of the element being represented must be returned. As this is a language model, the source code provides the fiducial (reference) representation of the construct in question rather than a representation in an executable output like a class file. Executable output may serve as the basis for creating a modeling element. However, the process of translating source code to executable output may not permit recovering some aspects of the source code representation. For example, annotations with source retention cannot be recovered from class files and class files might not be able to provide source position information. The modifiers on an element may differ in some cases including

Additionally, synthetic constructs in a class file, such as accessor methods used in implementing nested classes and bridge methods used in implementing covariant returns, are translation artifacts outside of this model.

During annotation processing, operating on incomplete or erroneous programs is necessary; however, there are fewer guarantees about the nature of the resulting model. If the source code is not syntactically well-formed, a model may or may not be provided as a quality of implementation issue. If a program is syntactically valid but erroneous in some other fashion, the returned model must have no less information than if all the method bodies in the program were replaced by "throw new RuntimeException();". If a program refers to a missing type XYZ, the returned model must contain no less information than if the declaration of type XYZ were assumed to be "class XYZ {}", "interface XYZ {}", "enum XYZ {}", or "@interface XYZ {}". If a program refers to a missing type XYZ<K1, ... ,Kn>, the returned model must contain no less information than if the declaration of XYZ were assumed to be "class XYZ<T1, ... ,Tn> {}" or "interface XYZ<T1, ... ,Tn> {}"

Unless otherwise specified in a particular implementation, the collections returned by methods in this package should be expected to be unmodifiable by the caller and unsafe for concurrent access.

Unless otherwise specified, methods in this package will throw a NullPointerException if given a null argument.


Java™ Platform
Standard Ed. 7

DRAFT ea-b118

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2010, Oracle Corporation. All rights reserved.
DRAFT ea-b118

Scripting on this page tracks web page traffic, but does not change the content in any way. - all specs in one place