FormalParameterList class

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

leftDelimiter Token
Return the left square bracket ('[') or left curly brace ('{') introducing the optional parameters, or null if there are no optional parameters.
read / write
leftParenthesis Token
Return the left parenthesis.
read / write
parameterElements → List<ParameterElement>
Return a list containing the elements representing the parameters in this list. [...]
read-only
parameters NodeList<FormalParameter>
Return the parameters associated with the method.
read-only
rightDelimiter Token
Return the right square bracket (']') or right curly brace ('}') terminating the optional parameters, or null if there are no optional parameters.
read / write
rightParenthesis Token
Return the right parenthesis.
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
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
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
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

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