FunctionDeclaration class

A top-level function declaration.

functionDeclaration ::= 'external' functionSignature | functionSignature FunctionBody

functionSignature ::= Type? ('get' | 'set')? SimpleIdentifier FormalParameterList

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

Implemented types

Constructors

FunctionDeclaration()

Properties

declaredElement ExecutableElement
Return the element associated with this declaration, or null if either this node corresponds to a list of declarations or if the AST structure has not been resolved.
read-only, override
externalKeyword Token
Return the token representing the 'external' keyword, or null if this is not an external function.
read / write
functionExpression FunctionExpression
Return the function expression being wrapped.
read / write
isGetter → bool
Return true if this function declares a getter.
read-only
isSetter → bool
Return true if this function declares a setter.
read-only
propertyKeyword Token
Return the token representing the 'get' or 'set' keyword, or null if this is a function declaration rather than a property declaration.
read / write
returnType TypeAnnotation
Return the return type of the function, or null if no return type was declared.
read / write
beginToken Token
Return the first token included in this node's source range.
read-only, inherited
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.
read-only, inherited
documentationComment Comment
Return the documentation comment associated with this node, or null if this node does not have a documentation comment associated with it.
read / write, inherited
end → int
Return the offset of the character immediately following the last character of this node's source range. [...]
read-only, inherited
endToken Token
Return the last token included in this node's source range.
read-only, inherited
firstTokenAfterCommentAndMetadata Token
Return the first token following the comment and metadata.
read-only, inherited
hashCode → int
The hash code for this object.
read-only, inherited
isSynthetic → bool
Return true if this node is a synthetic node. [...]
read-only, inherited
length → int
Return the number of characters in the syntactic entity's source range.
read-only, inherited
metadata NodeList<Annotation>
Return the annotations associated with this node.
read-only, inherited
name SimpleIdentifier
Return the name of the member being declared.
read / write, inherited
offset → int
Return the offset from the beginning of the file to the first character in the syntactic entity.
read-only, inherited
parent AstNode
Return this node's parent node, or null if this node is the root of an AST structure. [...]
read-only, inherited
root AstNode
Return the node at the root of this node's AST structure. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
sortedCommentAndAnnotations → List<AstNode>
Return a list containing the comment and annotations associated with this node, sorted in lexical order.
read-only, inherited

Methods

accept<E>(AstVisitor<E> visitor) → E
Use the given visitor to visit this node. [...]
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 non-existent 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>(Predicate<AstNode> predicate) → 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<T extends AstNode>() → T
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
Returns a string representation of this object.
inherited
visitChildren(AstVisitor visitor) → void
Use the given visitor to visit all of the children of this node. [...]
inherited

Operators

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