Element class abstract

The base class for all of the elements in the element model. Generally speaking, the element model is a semantic model of the program that represents things that are declared with a name and hence can be referenced elsewhere in the code.

There are two exceptions to the general case. First, there are elements in the element model that are created for the convenience of various kinds of analysis but that do not have any corresponding declaration within the source code. Such elements are marked as being synthetic. Examples of synthetic elements include

  • default constructors in classes that do not define any explicit constructors,
  • getters and setters that are induced by explicit field declarations,
  • fields that are induced by explicit declarations of getters and setters, and
  • functions representing the initialization expression for a variable.

Second, there are elements in the element model that do not have a name. These correspond to unnamed functions and exist in order to more accurately represent the semantic structure of the program.

Clients may not extend, implement or mix-in this class.

Implementers

Constructors

Element()

Properties

context → AnalysisContext
Return the analysis context in which this element is defined.
no setter
declaration → Element?
Return the declaration of this element. If the element is a view on an element, e.g. a method from an interface type, with substituted type parameters, return the corresponding element from the class, without any substitutions. If this element is already a declaration (or a synthetic element, e.g. a synthetic property accessor), return itself.
no setter
displayName → String
Return the display name of this element, possibly the empty string if this element does not have a name.
no setter
documentationComment → String?
Return the content of the documentation comment (including delimiters) for this element, or null if this element does not or cannot have documentation.
no setter
enclosingElement → Element?
Return the element that either physically or logically encloses this element. This will be null if this element is a library because libraries are the top-level elements in the model.
no setter
hasAlwaysThrows → bool
Return true if this element has an annotation of the form @alwaysThrows.
no setter
hasDeprecated → bool
Return true if this element has an annotation of the form @deprecated or @Deprecated('..').
no setter
hasDoNotStore → bool
Return true if this element has an annotation of the form @doNotStore.
no setter
hasFactory → bool
Return true if this element has an annotation of the form @factory.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasInternal → bool
Return true if this element has an annotation of the form @internal.
no setter
hasIsTest → bool
Return true if this element has an annotation of the form @isTest.
no setter
hasIsTestGroup → bool
Return true if this element has an annotation of the form @isTestGroup.
no setter
hasJS → bool
Return true if this element has an annotation of the form @JS(..).
no setter
hasLiteral → bool
Return true if this element has an annotation of the form @literal.
no setter
hasMustCallSuper → bool
Return true if this element has an annotation of the form @mustCallSuper.
no setter
hasNonVirtual → bool
Return true if this element has an annotation of the form @nonVirtual.
no setter
hasOptionalTypeArgs → bool
Return true if this element has an annotation of the form @optionalTypeArgs.
no setter
hasOverride → bool
Return true if this element has an annotation of the form @override.
no setter
hasProtected → bool
Return true if this element has an annotation of the form @protected.
no setter
hasRequired → bool
Return true if this element has an annotation of the form @required.
no setter
hasSealed → bool
Return true if this element has an annotation of the form @sealed.
no setter
hasUseResult → bool
Return true if this element has an annotation of the form @useResult or @UseResult('..').
no setter
hasVisibleForOverriding → bool
Return true if this element has an annotation of the form @visibleForOverriding.
no setter
hasVisibleForTemplate → bool
Return true if this element has an annotation of the form @visibleForTemplate.
no setter
hasVisibleForTesting → bool
Return true if this element has an annotation of the form @visibleForTesting.
no setter
id → int
The unique integer identifier of this element.
no setter
isPrivate → bool
Return true if this element is private. Private elements are visible only within the library in which they are declared.
no setter
isPublic → bool
Return true if this element is public. Public elements are visible within any library that imports the library in which they are declared.
no setter
isSynthetic → bool
Return true if this element is synthetic. A synthetic element is an element that is not represented in the source code explicitly, but is implied by the source code, such as the default constructor for a class that does not explicitly define any constructors.
no setter
kind → ElementKind
Return the kind of element that this is.
no setter
library → LibraryElement?
Return the library that contains this element. This will be the element itself if it is a library element. This will be null if this element is MultiplyDefinedElement that is not contained in a library.
no setter
librarySource → Source?
If this target is associated with a library, return the source of the library's defining compilation unit; otherwise return null.
no setterinherited
location → ElementLocation?
Return an object representing the location of this element in the element model. The object can be used to locate this element at a later time.
no setter
metadata → List<ElementAnnotation>
Return a list containing all of the metadata associated with this element. The array will be empty if the element does not have any metadata or if the library containing this element has not yet been resolved.
no setter
name → String?
Return the name of this element, or null if this element does not have a name.
no setter
nameLength → int
Return the length of the name of this element in the file that contains the declaration of this element, or 0 if this element does not have a name.
no setter
nameOffset → int
Return the offset of the name of this element in the file that contains the declaration of this element, or -1 if this element is synthetic, does not have a name, or otherwise does not have an offset.
no setter
nonSynthetic → Element
Return the non-synthetic element that caused this element to be created.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
session → AnalysisSession?
Return the analysis session in which this element is defined.
no setter
source → Source?
Return the source associated with this target, or null if this target is not associated with a source.
no setter

Methods

accept<T>(ElementVisitor<T> visitor) → T?
Use the given visitor to visit this element. Return the value returned by the visitor as a result of visiting this element.
getDisplayString({required bool withNullability, bool multiline = false}) → String
Return the presentation of this element as it should appear when presented to users.
getExtendedDisplayName(String? shortName) → String
Return a display name for the given element that includes the path to the compilation unit in which the type is defined. If shortName is null then displayName will be used as the name of this element. Otherwise the provided name will be used.
isAccessibleIn(LibraryElement? library) → bool
Return true if this element, assuming that it is within scope, is accessible to code in the given library. This is defined by the Dart Language Specification in section 3.2:
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
thisOrAncestorMatching<E extends Element>(bool predicate(Element)) → E?
Return either this element or the most immediate ancestor of this element for which the predicate returns true, or null if there is no such element.
thisOrAncestorOfType<E extends Element>() → E?
Return either this element or the most immediate ancestor of this element that has the given type, or null if there is no such element.
toString() → String
A string representation of this object.
inherited
visitChildren(ElementVisitor visitor) → void
Use the given visitor to visit all of the children of this element. There is no guarantee of the order in which the children will be visited.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

SORT_BY_OFFSET → Comparator<Element>
A comparator that can be used to sort elements by their name offset. Elements with a smaller offset will be sorted to be before elements with a larger name offset.
final