FunctionDeclaration class abstract

A function declaration.

Wrapped in a FunctionDeclarationStatement to represent a local function declaration, otherwise a top-level function declaration.

functionDeclaration ::= 'external' functionSignature | functionSignature FunctionBody

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

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

Implemented types

Constructors

FunctionDeclaration()

Properties

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

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 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.
inherited

Operators

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