AnnotationImpl class

An annotation that can be associated with an AST node.

metadata ::= annotation*

annotation ::= '@' Identifier ('.' SimpleIdentifier)? ArgumentList?

Inheritance

• Object
• AstNodeImpl
• AnnotationImpl

Implemented types

• Annotation

Available Extensions

• AstNodeUtils

Constructors

AnnotationImpl({required Token atSign, required IdentifierImpl name, required TypeArgumentListImpl? typeArguments, required Token? period, required SimpleIdentifierImpl? constructorName, required ArgumentListImpl? arguments})

Initialize a newly created annotation. Both the period and the constructorName can be null if the annotation is not referencing a named constructor. The arguments can be null if the annotation is not referencing a constructor.

Properties

arguments ↔ ArgumentListImpl?

Return the arguments to the constructor being invoked, or null if this annotation is not the invocation of a constructor.

getter/setter pair, override-getter

atSign → Token

The at sign that introduced the annotation.

final

beginToken → Token

Return the first token included in this node's source range.

no setter, override

childEntities → Iterable<SyntacticEntity>

Return an iterator that can be used to iterate through all the entities (either AST nodes or tokens) that make up the contents of this node, including doc comments but excluding other comments.

no setter, inherited

constructorName ↔ SimpleIdentifierImpl?

Return the name of the constructor being invoked, or null if this annotation is not the invocation of a named constructor.

getter/setter pair, override-getter

element ↔ Element?

Return the element associated with this annotation, or null if the AST structure has not been resolved or if this annotation could not be resolved.

getter/setter pair, override-getter

elementAnnotation ↔ ElementAnnotation?

The element annotation representing this annotation in the element model.

getter/setter pair, override-getter

end → int

Return the offset of the character immediately following the last character of this node's source range.

no setter, inherited

endToken → Token

Return the last token included in this node's source range.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

isSynthetic → bool

Return true if this node is a synthetic node.

no setter, inherited

length → int

Return the number of characters in the syntactic entity's source range.

no setter, inherited

name ↔ IdentifierImpl

Return the name of the class defining the constructor that is being invoked or the name of the field that is being referenced.

getter/setter pair, override-getter

namedChildEntities → Iterable<ChildEntity>

Return properties (tokens and nodes) of this node, with names, in the order in which these entities should normally appear, not necessary in the order they really are (because of recovery).

no setter, inherited

offset → int

Return the offset from the beginning of the file to the first character in the syntactic entity.

no setter, inherited

parent → AstNode

Return this node's parent node, or null if this node is the root of an AST structure.

no setter, override

period → Token?

The period before the constructor name, or null if this annotation is not the invocation of a named constructor.

final

root → AstNode

Return the node at the root of this node's AST structure.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

typeArguments ↔ TypeArgumentListImpl?

Returns the type arguments to the constructor being invoked, or null if (a) this annotation is not the invocation of a constructor or (b) this annotation does not specify type arguments explicitly.

getter/setter pair, override-getter

Methods

accept<E>(AstVisitor<E> visitor) → E?

Use the given visitor to visit this node.

override

detachFromParent() → void

inherited

findPrevious(Token target) → Token?

Return the token before target or null if it cannot be found.

inherited

getProperty<E>(String name) → E?

Return the value of the property with the given name, or null if this node does not have a property with the given name.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setProperty(String name, Object? value) → void

Set the value of the property with the given name to the given value. If the value is null, the property will effectively be removed.

inherited

thisOrAncestorMatching<E extends AstNode>(bool predicate(AstNode)) → E?

Return either this node or the most immediate ancestor of this node for which the predicate returns true, or null if there is no such node.

inherited

thisOrAncestorOfType<E extends AstNode>() → E?

Return either this node or the most immediate ancestor of this node that has the given type, or null if there is no such node.

inherited

toSource() → String

Return a textual description of this node in a form approximating valid source.

inherited

toString() → String

A string representation of this object.

inherited

visitChildren(AstVisitor visitor) → void

Use the given visitor to visit all of the children of this node.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited