EnumDeclarationImpl class
The declaration of an enumeration.
enumType ::= metadata 'enum' SimpleIdentifier TypeParameterList? WithClause? ImplementsClause? '{' SimpleIdentifier (',' SimpleIdentifier)* (';' ClassMember+)? '}'
- Inheritance
- Implemented types
- Available Extensions
Constructors
-
EnumDeclarationImpl({required CommentImpl? comment, required List<
AnnotationImpl> ? metadata, required Token enumKeyword, required Token name, required TypeParameterListImpl? typeParameters, required WithClauseImpl? withClause, required ImplementsClauseImpl? implementsClause, required Token leftBracket, required List<EnumConstantDeclarationImpl> constants, required Token? semicolon, required List<ClassMemberImpl> members, required Token rightBracket}) -
Initialize a newly created enumeration declaration. Either or both of the
comment
andmetadata
can benull
if the declaration does not have the corresponding attribute. The list ofconstants
must contain at least one value.
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
-
constants
→ NodeListImpl<
EnumConstantDeclarationImpl> -
Return the enumeration constants being declared.
no setteroverride
- declaredElement ↔ EnumElement?
-
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.getter/setter pairoverride-getter - declaredElement2 → EnumElement?
-
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 ↔ CommentImpl?
-
Return the documentation comment associated with this node, or
null
if this node does not have a documentation comment associated with it.getter/setter pairinherited - 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 setteroverride
- enumKeyword → Token
-
The 'enum' keyword.
final
- firstTokenAfterCommentAndMetadata → Token
-
Return the first token following the comment and metadata.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- implementsClause ↔ ImplementsClauseImpl?
-
Returns the
implements
clause for the enumeration, ornull
if the enumeration does not implement any interfaces.getter/setter pairoverride-getter - isSynthetic → bool
-
Return
true
if this node is a synthetic node.no setterinherited - leftBracket → Token
-
The left curly bracket.
final
- length → int
-
Return the number of characters in the syntactic entity's source range.
no setterinherited
-
members
→ NodeListImpl<
ClassMemberImpl> -
Return the members declared by the enumeration.
no setteroverride
-
metadata
→ NodeListImpl<
AnnotationImpl> -
Return the annotations associated with this node.
no setterinherited
- name → Token
-
The name of the member being declared.
finalinherited
- name2 → Token
-
Return the name of the member being declared.
no setterinherited
-
namedChildEntities
→ Iterable<
ChildEntity> -
Return properties (tokens and nodes) of this node, with names, in the
order in which these entities should normally appear, not necessary in
the order they really are (because of recovery).
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 - rightBracket → Token
-
The right curly bracket.
final
- 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
- semicolon → Token?
-
Return the optional semicolon after the last constant.
final
-
sortedCommentAndAnnotations
→ List<
AstNode> -
Return a list containing the comment and annotations associated with this
node, sorted in lexical order.
no setterinherited
- typeParameters ↔ TypeParameterListImpl?
-
Returns the type parameters for the enumeration, or
null
if the enumeration does not have any type parameters.getter/setter pairoverride-getter - withClause ↔ WithClauseImpl?
-
Return the
with
clause for the enumeration, ornull
if the enumeration does not have awith
clause.getter/setter pairoverride-getter
Methods
-
accept<
E> (AstVisitor< E> visitor) → E? -
Use the given
visitor
to visit this node.override -
detachFromParent(
) → void -
inherited
-
findPrevious(
Token target) → Token? -
Return the token before
target
ornull
if it cannot be found.inherited -
getProperty<
E> (String name) → E? -
Return the value of the property with the given
name
, ornull
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 givenvalue
. If the value isnull
, 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
returnstrue
, ornull
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.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited