Container class

A Container represents a Dart construct that can contain methods, operators, and fields, such as Class, Enum, or Extension.

Member naming in Container follows these general rules:

instance : Members named 'instance' contain the children of this container that can be referenced from within the container without a prefix. Usually overridden in subclasses with calls to super. constant : Members named 'constant' contain children declared constant. variable : The opposite of constant. For the templating system. static : Members named 'static' are related to static children of this container. public : Filtered versions of the getters showing only public items. Mostly for the templating system. sorted : Filtered versions of the getters creating a sorted list by name. For the templating system. has : boolean getters indicating whether the underlying getters are empty. Mostly for the templating system. all : Referring to all children.

Inheritance
Mixed in types
Implementers

Constructors

Container(Element element, Library library, PackageGraph packageGraph)

Properties

allElements Set<Element>
read-only
allModelElements Iterable<ModelElement>
@mustCallSuper, read-only
allModelElementsByNamePart Map<String, List<ModelElement>>
Helper for _MarkdownCommentReference._getResultsForClass.
read-only
allParameters List<Parameter>
read-only, inherited
annotations List<String>
read-only, inherited
canHaveParameters bool
read-only, inherited
canonicalLibrary Library
read-only, inherited
canonicalModelElement ModelElement
read-only, inherited
characterLocation CharacterLocation
read-only, inherited
commentRefs List<ModelCommentReference>
read-only, inherited
compilationUnitElement CompilationUnitElement
read-only, inherited
computeDocumentationFrom List<ModelElement>
Returns the ModelElement(s) from which we will get documentation. Can be more than one if this is a Field composing documentation from multiple Accessors. [...]
read-only, inherited
config DartdocOptionContext
read-only, inherited
constantFields Iterable<Field>
read-only
declaredFields Iterable<Field>
Fields fully declared in this Container.
read-only
declaredMethods Iterable<Method>
All methods, including operators and statics, declared as part of this Container. declaredMethods must be the union of instanceMethods, staticMethods, and instanceOperators.
read-only
declaredOperators Iterable<Operator>
@nonVirtual, read-only
definingLibrary Library
read-only, inherited
displayedCategories Iterable<Category>
read-only, inherited
displayedLanguageFeatures Iterable<LanguageFeature>
A list of language features that both apply to this ModelElement and make sense to display in context.
read-only, inherited
documentation String
Returns the docs, stripped of their leading comments syntax.
read-only, inherited
documentationAsHtml String
read-only, inherited
documentationComment String
read-only, inherited
documentationFrom List<ModelElement>
read-only, inherited
documentationIsLocal bool
True if documentationFrom contains only one item, this.
read-only, inherited
documentationLocal String
read-only, inherited
element Element
read-only, inherited
enclosingElement → Warnable
read-only, inherited
exportedInLibraries Set<Library>
read-only, inherited
Returns a link to extended documentation, or the empty string if that does not exist.
read-only, inherited
features Set<String>
read-only, inherited
featuresAsString String
read-only, inherited
fileName String
read-only, inherited
filePath String
read-only, inherited
fileType String
read-only, inherited
fullyQualifiedName String
Returns the fully qualified name. [...]
read-only, inherited
fullyQualifiedNameWithoutLibrary String
read-only, inherited
genericParameters String
read-only, inherited
hasAnnotations bool
read-only, inherited
hasCategoryNames bool
read-only, inherited
hasDocumentation bool
read-only, inherited
hasExtendedDocumentation bool
read-only, inherited
hasFeatureSet bool
read-only, inherited
hasGenericParameters bool
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
hasInstanceFields bool
read-only
hasNodoc bool
Returns true if the raw documentation comment has a nodoc indication.
read-only, inherited
hasParameters bool
read-only, inherited
hasPublicConstantFields bool
read-only
hasPublicConstructors bool
Whether any constructors are public. [...]
read-only
hasPublicInstanceFields bool
@nonVirtual, read-only
hasPublicInstanceMethods bool
@nonVirtual, read-only
hasPublicInstanceOperators bool
@nonVirtual, read-only
hasPublicStaticFields bool
read-only
hasPublicStaticMethods bool
read-only
hasPublicVariableStaticFields bool
read-only
hasSourceCode bool
read-only, inherited
hasSourceHref bool
read-only, inherited
href String
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable subclasses) is null, href should be null.
read-only, inherited
htmlId String
read-only, inherited
instanceAccessors Iterable<Accessor>
read-only
instanceFields Iterable<Field>
All fields accessible in this instance that are not static.
read-only
instanceMethods Iterable<Method>
read-only
instanceOperators Iterable<Operator>
read-only
isAsynchronous bool
read-only, inherited
isCanonical bool
read-only, inherited
isClass bool
read-only
isConst bool
read-only, inherited
isDeprecated bool
read-only, inherited
isDocumented bool
read-only, inherited
isExecutable bool
read-only, inherited
isExtension bool
read-only
isFinal bool
read-only, inherited
isLate bool
read-only, inherited
isLocalElement bool
read-only, inherited
isNullSafety bool
read-only, inherited
isPropertyAccessor bool
read-only, inherited
isPropertyInducer bool
read-only, inherited
isPublic bool
read-only, inherited
isPublicAndPackageDocumented bool
read-only, inherited
isStatic bool
read-only, inherited
kind String
A human-friendly name for the kind of element this is.
read-only, inherited
library Library
read-only, inherited
linkedGenericParameters String
read-only, inherited
linkedName String
read-only, inherited
linkedParams String
read-only, inherited
linkedParamsLines String
read-only, inherited
linkedParamsNoMetadata String
read-only, inherited
linkedParamsNoMetadataOrNames String
read-only, inherited
location String
A string indicating the URI of this Locatable, usually derived from Element.location.
read-only, inherited
locationPieces Set<String>
Pieces of the location, split to remove 'package:' and slashes.
read-only, inherited
modelElementRenderer → ModelElementRenderer
@visibleForTesting, read-only, inherited
modelNode ModelNode
read-only, inherited
modelType ElementType
read-only, inherited
name String
read-only, inherited
namePart String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
read-only, inherited
namePieces Set<String>
read-only, inherited
nameWithGenerics String
read-only, inherited
nameWithLinkedGenerics String
read-only, inherited
oneLineDoc String
read-only, inherited
originalMember → Member
read-only, inherited
overriddenDepth int
read-only, inherited
package Package
read-only, inherited
packageGraph PackageGraph
read-only, inherited
parameters List<Parameter>
read-only, inherited
pathContext Context
read-only, inherited
publicConstantFields Iterable<Field>
read-only
publicConstantFieldsSorted List<Field>
read-only
publicConstructorsSorted Iterable<Constructor>
read-only
publicInheritedInstanceFields bool
Whether all instance fields are inherited. [...]
read-only
publicInheritedInstanceMethods bool
Whether all instance methods are inherited. [...]
read-only
publicInheritedInstanceOperators Iterable<Operator>
read-only
publicInstanceFields Iterable<Field>
@nonVirtual, read-only
publicInstanceFieldsSorted List<Field>
read-only
publicInstanceMethods Iterable<Method>
read-only
publicInstanceMethodsSorted List<Method>
read-only
publicInstanceOperators Iterable<Operator>
@nonVirtual, read-only
publicInstanceOperatorsSorted List<Operator>
read-only
publicStaticFields Iterable<Field>
read-only
publicStaticFieldsSorted List<Field>
read-only
publicStaticMethods Iterable<Method>
read-only
publicStaticMethodsSorted List<Method>
read-only
publicVariableStaticFields Iterable<Field>
read-only
publicVariableStaticFieldsSorted List<Field>
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sourceCode String
read-only, inherited
sourceFileName String
read-only, inherited
sourceHref String
read-only, inherited
staticAccessors Iterable<Accessor>
read-only
staticFields Iterable<Field>
read-only
staticMethods Iterable<Method>
read-only
typeParameters List<TypeParameter>
read-only, inherited
variableStaticFields Iterable<Field>
read-only

Methods

annotationsFromMetadata(Iterable<ElementAnnotation> md) List<String>
Returns linked annotations from a given metadata set, with escaping.
inherited
buildCanonicalModelElement() ModelElement
inherited
buildDocumentationAddition(String docs) String
Override this to add more features to the documentation builder in a subclass.
inherited
compareTo(dynamic other) int
Compares this object to another Comparable [...]
inherited
computeDocumentationComment() String
Implement to derive the raw documentation comment string from the analyzer.
inherited
containsElement(Element element) bool
This container might be canonical for elements it does not contain. See Inheritable.canonicalEnclosingContainer.
memberByExample<T extends ModelElement>(T example) → T
Given a ModelElement that is a member of some other class, return the member of this class that has the same name and runtime type. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
precacheLocalDocs() Future<void>
Unconditionally precache local documentation. [...]
inherited
processComment(String documentationComment) Future<String>
Process documentationComment, performing various actions based on {@}-style directives, returning the processed result.
inherited
processCommentDirectives(String docs) String
inherited
processCommentWithoutTools(String documentationComment) String
Process a documentationComment, performing various actions based on {@}-style directives, except {@tool}, returning the processed result.
inherited
scoreCanonicalCandidates(Iterable<Library> libraries) List<ScoredCandidate>
inherited
scoreElementWithLibrary(Library lib) ScoredCandidate
@Deprecated('Public method intended to be private; will be removed as early as ' 'Dartdoc 1.0.0'), inherited
setModelType(ElementType type) → void
inherited
toString() String
Returns a string representation of this object.
inherited
warn(PackageWarning kind, {String message, Iterable<Locatable> referredFrom, Iterable<String> extendedDebug}) → void
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited