FormalParameterList class abstract

The formal parameter list of a method declaration, function declaration, or function type alias.

While the grammar requires all optional formal parameters to follow all of the normal formal parameters and at most one grouping of optional formal parameters, this class does not enforce those constraints. All parameters are flattened into a single list, which can have any or all kinds of parameters (normal, named, and positional) in any order.

formalParameterList ::= '(' ')' | '(' normalFormalParameters (',' optionalFormalParameters)? ')' | '(' optionalFormalParameters ')'

normalFormalParameters ::= NormalFormalParameter (',' NormalFormalParameter)*

optionalFormalParameters ::= optionalPositionalFormalParameters | namedFormalParameters

optionalPositionalFormalParameters ::= '[' DefaultFormalParameter (',' DefaultFormalParameter)* ']'

namedFormalParameters ::= '{' DefaultFormalParameter (',' DefaultFormalParameter)* '}'

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

Implemented types

Constructors

FormalParameterList()

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
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
hashCode → int
The hash code for this object.
no setterinherited
isSynthetic → bool
Return true if this node is a synthetic node.
no setterinherited
leftDelimiter → Token?
Return the left square bracket ('[') or left curly brace ('{') introducing the optional parameters, or null if there are no optional parameters.
no setter
leftParenthesis → Token
Return the left parenthesis.
no setter
length → int
Return the number of characters in the syntactic entity's source range.
no setterinherited
offset → int
Return the offset from the beginning of the file to the first character in the syntactic entity.
no setterinherited
parameterElements → List<ParameterElement?>
Return a list containing the elements representing the parameters in this list.
no setter
parameters → NodeList<FormalParameter>
Return the parameters associated with the method.
no setter
parent → AstNode?
Return this node's parent node, or null if this node is the root of an AST structure.
no setterinherited
rightDelimiter → Token?
Return the right square bracket (']') or right curly brace ('}') terminating the optional parameters, or null if there are no optional parameters.
no setter
rightParenthesis → Token
Return the right parenthesis.
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

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