VariableElement class

A variable. There are more specific subclasses for more specific kinds of variables.

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

Implemented types
Implementers

Constructors

VariableElement()

Properties

constantValue DartObject
Return a representation of the value of this variable. [...]
read-only
declaration VariableElement
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.
read-only, override
hasImplicitType → bool
Return true if this variable element did not have an explicit type specified for it.
read-only
initializer FunctionElement
Return a synthetic function representing this variable's initializer, or null if this variable does not have an initializer. The function will have no parameters. The return type of the function will be the compile-time type of the initialization expression.
read-only
isConst → bool
Return true if this variable was declared with the 'const' modifier.
read-only
isFinal → bool
Return true if this variable was declared with the 'final' modifier. Variables that are declared with the 'const' modifier will return false even though they are implicitly final.
read-only
isLate → bool
Return true if this variable uses late evaluation semantics. [...]
@experimental, read-only
isStatic → bool
Return true if this element is a static variable, as per section 8 of the Dart Language Specification: [...]
read-only
type DartType
Return the declared type of this variable, or null if the variable did not have a declared type (such as if it was declared using the keyword 'var').
read-only
context → AnalysisContext
Return the AnalysisContext which should be used to evaluate this constant.
read-only, inherited
displayName → String
Return the display name of this element, or null if this element does not have a name. [...]
read-only, inherited
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.
read-only, inherited
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.
read-only, inherited
hasAlwaysThrows → bool
Return true if this element has an annotation of the form @alwaysThrows.
read-only, inherited
hasDeprecated → bool
Return true if this element has an annotation of the form @deprecated or @Deprecated('..').
read-only, inherited
hasFactory → bool
Return true if this element has an annotation of the form @factory.
read-only, inherited
hashCode → int
The hash code for this object.
read-only, inherited
hasIsTest → bool
Return true if this element has an annotation of the form @isTest.
read-only, inherited
hasIsTestGroup → bool
Return true if this element has an annotation of the form @isTestGroup.
read-only, inherited
hasJS → bool
Return true if this element has an annotation of the form @JS(..).
read-only, inherited
hasLiteral → bool
Return true if this element has an annotation of the form @literal.
read-only, inherited
hasMustCallSuper → bool
Return true if this element has an annotation of the form @mustCallSuper.
read-only, inherited
hasNonVirtual → bool
Return true if this element has an annotation of the form @nonVirtual.
read-only, inherited
hasOptionalTypeArgs → bool
Return true if this element has an annotation of the form @optionalTypeArgs.
read-only, inherited
hasOverride → bool
Return true if this element has an annotation of the form @override.
read-only, inherited
hasProtected → bool
Return true if this element has an annotation of the form @protected.
read-only, inherited
hasRequired → bool
Return true if this element has an annotation of the form @required.
read-only, inherited
hasSealed → bool
Return true if this element has an annotation of the form @sealed.
read-only, inherited
hasVisibleForTemplate → bool
Return true if this element has an annotation of the form @visibleForTemplate.
read-only, inherited
hasVisibleForTesting → bool
Return true if this element has an annotation of the form @visibleForTesting.
read-only, inherited
id → int
The unique integer identifier of this element.
read-only, inherited
isConstantEvaluated → bool
Return whether this constant is evaluated.
read-only, inherited
isPrivate → bool
Return true if this element is private. Private elements are visible only within the library in which they are declared.
read-only, inherited
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.
read-only, inherited
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.
read-only, inherited
kind ElementKind
Return the kind of element that this is.
read-only, inherited
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 an HTML file because HTML files are not contained in libraries.
read-only, inherited
librarySource → Source
If this target is associated with a library, return the source of the library's defining compilation unit; otherwise return null.
read-only, inherited
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.
read-only, inherited
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.
read-only, inherited
name → String
Return the name of this element, or null if this element does not have a name.
read-only, inherited
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.
read-only, inherited
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.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
session AnalysisSession
Return the analysis session in which this element is defined.
read-only, inherited
source → Source
Return the source associated with this target, or null if this target is not associated with a source.
read-only, inherited

Methods

computeConstantValue() DartObject
Return a representation of the value of this variable, forcing the value to be computed if it had not previously been computed, or null if either this variable was not declared with the 'const' modifier or if the value of this variable could not be computed because of errors.
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.
inherited
getAncestor<E extends Element>(Predicate<Element> predicate) → E
Return the most immediate ancestor of this element for which the predicate returns true, or null if there is no such ancestor. Note that this element will never be returned.
inherited
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.
inherited
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: [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns 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.
inherited

Operators

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