ClassDeclaration class

The declaration of a class.

classDeclaration ::= 'abstract'? 'class' SimpleIdentifier TypeParameterList? (ExtendsClause WithClause?)? ImplementsClause? '{' ClassMember* '}'

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

Inheritance

Constructors

ClassDeclaration()

Properties

abstractKeyword Token
Return the 'abstract' keyword, or null if the keyword was absent.
read / write
classKeyword Token
Return the token representing the 'class' keyword.
read / write
declaredElement ClassElement
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
element ClassElement
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
extendsClause ExtendsClause
Return the extends clause for this class, or null if the class does not extend any other class.
read / write
implementsClause ImplementsClause
Return the implements clause for the class, or null if the class does not implement any interfaces.
read / write
isAbstract → bool
Return true if this class is declared to be an abstract class.
read-only
leftBracket Token
Return the left curly bracket.
read / write
members NodeList<ClassMember>
Return the members defined by the class.
read-only
nativeClause NativeClause
Return the native clause for this class, or null if the class does not have a native clause.
read / write
rightBracket Token
Return the right curly bracket.
read / write
typeParameters TypeParameterList
Return the type parameters for the class, or null if the class does not have any type parameters.
read / write
withClause WithClause
Return the with clause for the class, or null if the class does not have a with clause.
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. This is equivalent to node.getOffset() + node.getLength(). For a compilation unit this will be equal to the length of the unit's source. For synthetic nodes this will be equivalent to the node's offset (because the length is zero (0) by definition).
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. A synthetic node is a node that was introduced by the parser in order to recover from an error in the code. Synthetic nodes always have a length of zero (0).
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. Note that this method's performance is linear with respect to the depth of the node in the AST structure (O(depth)).
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

getConstructor(String name) ConstructorDeclaration
Return the constructor declared in the class with the given name, or null if there is no such constructor. If the name is null then the default constructor will be searched for.
getField(String name) VariableDeclaration
Return the field declared in the class with the given name, or null if there is no such field.
getMethod(String name) MethodDeclaration
Return the method declared in the class with the given name, or null if there is no such method.
accept<E>(AstVisitor<E> visitor) → E
Use the given visitor to visit this node. Return the value returned by the visitor as a result of visiting this node.
inherited
findPrevious(Token target) Token
Return the token before target or null if it cannot be found.
inherited
getAncestor<E extends AstNode>(Predicate<AstNode> predicate) → E
Return the most immediate ancestor of this node for which the predicate returns true, or null if there is no such ancestor. Note that this node will never be returned.
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
toSource() → String
Return a textual description of this node in a form approximating valid source. The returned string will not be valid source primarily in the case where the node itself is not well-formed.
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. The children will be visited in lexical order.
inherited

Operators

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