InheritingContainer class abstract
A Container that participates in inheritance in Dart.
Members follow similar naming rules to Container, with the following additions:
- instance: As with Container, but also includes inherited children.
- inherited: Filtered getters giving only inherited children.
- Inheritance
-
- Object
- Canonicalization
- ModelElement
- Container
- InheritingContainer
- Implemented types
- Implementers
Constructors
- InheritingContainer(ClassElement element, Library? library, PackageGraph packageGraph)
Properties
-
allCanonicalModelElements
→ List<
ModelElement> -
no setterinherited
-
allElements
→ Set<
Element?> -
latefinalinherited
-
allFields
→ List<
Field> -
latefinal
-
allModelElements
→ List<
ModelElement> -
no setteroverride
-
allParameters
→ List<
Parameter> -
latefinalinherited
-
annotations
→ Iterable<
Annotation> -
latefinalinherited
- canonicalLibrary → Library?
-
latefinalinherited
- canonicalModelElement → ModelElement?
-
latefinalinherited
-
categories
→ Iterable<
Category> -
latefinalinherited
-
categoryNames
→ List<
String> ? -
Either a set of strings containing all declared categories for this symbol,
or 'null' if none were declared.
no setterinherited
- characterLocation → CharacterLocation?
-
latefinalinherited
- compilationUnitElement → CompilationUnitElement?
-
no setterinherited
- config → DartdocOptionContext
-
latefinalinherited
-
constantFields
→ Iterable<
Field> -
no setteroverride
-
declaredFields
→ Iterable<
Field> -
Fields fully declared in this Container.
no setteroverride
-
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.
no setteroverride
-
declaredOperators
→ Iterable<
Operator> -
latefinalinherited
- definingCommentReferable → CommentReferable
-
For testing / comparison only, get the comment referable from where this
ElementType was defined. Override where an
Element
is available.no setterinherited - definingContainer → InheritingContainer
-
Returns the InheritingContainer with the library in which element is defined.
no setter
- definingLibrary → Library
-
no setterinherited
-
displayedCategories
→ Iterable<
Category> -
no setterinherited
-
displayedLanguageFeatures
→ Iterable<
LanguageFeature> -
A list of language features that both apply to this ModelElement and
make sense to display in context.
no setterinherited
- documentation → String
-
Returns the docs, stripped of their leading comments syntax.
no setterinherited
- documentationAsHtml → String?
-
latefinalinherited
- documentationComment → String
-
The rawest form of the documentation comment, including comment delimiters
like
///
,//
,/*
,*/
.no setterinherited -
documentationFrom
→ List<
DocumentationComment> -
The ModelElement from which we will get documentation.
no setterinherited
- documentationIsLocal → bool
-
True if documentationFrom contains only one item,
this
.no setterinherited - documentationLocal → String?
-
no setterinherited
- element → ClassElement?
-
ClassElement
is analogous to InheritingContainer.no setteroverride - elementDocumentation → Documentation
-
latefinalinherited
- enclosingElement → ModelElement?
-
Returns the library that encloses this element.
no setteroverride
-
exportedInLibraries
→ Set<
Library> ? -
no setterinherited
-
extraReferenceChildren
→ Iterable<
MapEntry< String, CommentReferable> > -
For subclasses to add items after the main pass but before the
parameter-global.
no setterinherited
-
features
→ Set<
Feature> -
Usually a superset of annotations except where
_specialFeatures
replace them, a list of annotations as well as tags applied by Dartdoc itself when it notices characteristics of an element that need to be documented. SeeFeature
for a list.no setterinherited - featuresAsString → String
-
no setterinherited
- fileName → String
-
no setterinherited
- filePath → String
-
no setteroverride
- fileType → String
-
no setterinherited
- fullkind → String
-
no setter
- fullyQualifiedName → String
-
Returns the fully qualified name.
latefinalinherited
- fullyQualifiedNameWithoutLibrary → String
-
no setterinherited
- genericParameters → String
-
no setterinherited
- hasAnnotations → bool
-
no setterinherited
- hasCategorization → bool
-
True if categories, subcategories, a documentation icon, or samples were
declared.
latefinalinherited
- hasCategoryNames → bool
-
no setterinherited
- hasDocumentation → bool
-
no setterinherited
- hasDocumentationComment → bool
-
True if
this
has a synthetic/inherited or local documentation comment. False otherwise.no setterinherited - hasFeatures → bool
-
no setterinherited
- hasFeatureSet → bool
-
no setterinherited
- hasGenericParameters → bool
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasImage → bool
-
no setterinherited
- hasInstanceFields → bool
-
no setterinherited
- hasModifiers → bool
-
no setter
- hasNodoc → bool
-
Returns true if the raw documentation comment has a 'nodoc' indication.
latefinalinherited
- hasParameters → bool
-
no setterinherited
- hasPotentiallyApplicableExtensions → bool
-
no setterinherited
- hasPublicConstantFields → bool
-
no setterinherited
- hasPublicConstructors → bool
-
Override if this is Constructable.
no setterinherited
- hasPublicEnumValues → bool
-
no setterinherited
- hasPublicInheritedMethods → bool
-
no setter
- hasPublicInstanceFields → bool
-
no setterinherited
- hasPublicInstanceMethods → bool
-
no setterinherited
- hasPublicInstanceOperators → bool
-
no setterinherited
- hasPublicStaticFields → bool
-
no setterinherited
- hasPublicStaticMethods → bool
-
no setterinherited
- hasPublicSuperChainReversed → bool
-
no setter
- hasPublicVariableStaticFields → bool
-
no setterinherited
- hasSamples → bool
-
no setterinherited
- hasSourceCode → bool
-
no setterinherited
- hasSourceHref → bool
-
no setterinherited
- hasSubCategoryNames → bool
-
no setterinherited
- href → String?
-
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable
subclasses) is null, href should be null.
no setterinherited
- htmlId → String
-
no setterinherited
- image → String?
-
Either a URI to a defined image,
or 'null' if one was not declared.
no setterinherited
-
inheritanceChain
→ List<
InheritingContainer?> -
Not the same as superChain as it may include mixins.
no setter
-
inheritedFields
→ Iterable<
Field> -
no setter
-
inheritedMethods
→ Iterable<
Method> -
latefinal
-
inheritedOperators
→ List<
Operator> -
latefinal
-
instanceAccessors
→ Iterable<
Accessor> -
no setterinherited
-
instanceFields
→ Iterable<
Field> -
All fields accessible in this instance that are not static.
no setteroverride
-
instanceMethods
→ Iterable<
Method> -
no setteroverride
-
instanceOperators
→ Iterable<
Operator> -
no setteroverride
- isAsynchronous → bool
-
no setterinherited
- isCallable → bool
-
no setterinherited
- isCanonical → bool
-
no setteroverride
- isClass → bool
-
Whether this a class or mixin, but not an enum.
no setterinherited
- isClassOrEnum → bool
-
Whether this is a class or an enum.
no setterinherited
- isClassOrEnumOrExtension → bool
-
Whether this is a class, an enum, or an extension.
no setterinherited
- isConst → bool
-
no setterinherited
- isDeprecated → bool
-
no setterinherited
- isDocumented → bool
-
no setterinherited
- isEnum → bool
-
Whether this is an enum.
no setterinherited
- isEnumValue → bool
-
Whether this element is an enum value.
no setterinherited
- isExecutable → bool
-
no setterinherited
- isExtension → bool
-
no setterinherited
- isFinal → bool
-
no setterinherited
- isLate → bool
-
no setterinherited
- isLocalElement → bool
-
no setterinherited
- isMixin → bool
-
Whether this is a mixin.
no setterinherited
- isNullSafety → bool
-
no setterinherited
- isPropertyAccessor → bool
-
no setterinherited
- isPropertyInducer → bool
-
no setterinherited
- isPublic → bool
-
latefinalinherited
- isPublicAndPackageDocumented → bool
-
no setterinherited
- isStatic → bool
-
no setterinherited
- kind → String
-
A human-friendly name for the kind of element this is.
no setterinherited
- library → Library
-
Containers must have associated libraries.
no setterinherited
- linkedGenericParameters → String
-
no setterinherited
- linkedName → String
-
latefinalinherited
- linkedObjectType → String
-
no setterinherited
- linkedParams → String
-
no setterinherited
- linkedParamsLines → String
-
no setterinherited
- linkedParamsNoMetadata → String?
-
no setterinherited
- linkedParamsNoMetadataOrNames → String
-
no setterinherited
- location → String
-
A string indicating the URI of this Locatable, usually derived from
Element.location
.no setterinherited -
locationPieces
→ Set<
String> -
Pieces of the location, split to remove 'package:' and slashes.
latefinalinherited
- modelBuilder → ModelObjectBuilder
-
Override implementations in unit tests to avoid requiring literal
ModelElements.
latefinalinherited
- modelElementRenderer → ModelElementRenderer
-
no setterinherited
- modelNode → ModelNode?
-
latefinalinherited
- modelType → DefinedElementType
-
no setter
- name → String
-
no setterinherited
- namePart → String
-
Utility getter/cache for
_MarkdownCommentReference._getResultsForClass
.latefinalinherited -
namePieces
→ Set<
String> -
latefinalinherited
- nameWithGenerics → String
-
no setterinherited
- nameWithLinkedGenerics → String
-
no setterinherited
- needsPrecache → bool
-
no setterinherited
- oneLineDoc → String?
-
no setterinherited
- originalMember → Member?
-
no setterinherited
- overriddenDepth → int?
-
no setterinherited
- package → Package
-
Containers must have associated packages.
no setterinherited
- packageGraph → PackageGraph
-
no setterinherited
-
parameters
→ List<
Parameter> -
latefinalinherited
- pathContext → Context
-
no setterinherited
-
potentiallyApplicableExtensions
→ Iterable<
Extension> ? -
The set of potentiallyApplicableExtensions, for display in templates.
no setterinherited
-
potentiallyApplicableExtensionsSorted
→ List<
Extension> -
no setterinherited
-
publicConstantFields
→ Iterable<
Field> -
no setterinherited
-
publicConstantFieldsSorted
→ List<
Field> -
latefinalinherited
-
publicConstructorsSorted
→ Iterable<
Constructor> -
no setterinherited
-
publicEnumValues
→ Iterable<
Field> -
no setterinherited
-
publicInheritedFields
→ Iterable<
Field> -
no setter
- publicInheritedInstanceFields → bool
-
Whether all instance fields are inherited.
no setteroverride
- publicInheritedInstanceMethods → bool
-
Whether all instance methods are inherited.
no setteroverride
- publicInheritedInstanceOperators → bool
-
Whether all instance operators are inherited.
no setteroverride
-
publicInheritedMethods
→ Iterable<
Method> -
no setter
-
publicInstanceFields
→ Iterable<
Field> -
no setterinherited
-
publicInstanceFieldsSorted
→ List<
Field> -
latefinalinherited
-
publicInstanceMethods
→ Iterable<
Method> -
no setterinherited
-
publicInstanceMethodsSorted
→ List<
Method> -
no setterinherited
-
publicInstanceOperators
→ Iterable<
Operator> -
no setterinherited
-
publicInstanceOperatorsSorted
→ List<
Operator> -
latefinalinherited
-
publicInterfaces
→ Iterable<
DefinedElementType> -
no setter
-
publicStaticFields
→ Iterable<
Field> -
no setterinherited
-
publicStaticFieldsSorted
→ List<
Field> -
latefinalinherited
-
publicStaticMethods
→ Iterable<
Method> -
no setterinherited
-
publicStaticMethodsSorted
→ List<
Method> -
latefinalinherited
-
publicSuperChain
→ List<
DefinedElementType> -
latefinal
-
publicSuperChainReversed
→ Iterable<
DefinedElementType> -
no setter
-
publicVariableStaticFields
→ Iterable<
Field> -
no setterinherited
-
publicVariableStaticFieldsSorted
→ List<
Field> -
latefinalinherited
-
referenceChildren
→ Map<
String, CommentReferable> -
Map of referenceName to the elements that are a member of
this
, but not this model element itself. Can be cached.latefinalinherited -
referenceGrandparentOverrides
→ Iterable<
CommentReferable> ? -
Replace the parents of parents.
referenceBy
ignores whatever might otherwise be implied by thereferenceParents
ofreferenceParents
, replacing them with this.no setterinherited - referenceName → String
-
no setterinherited
-
referenceParents
→ Iterable<
CommentReferable> -
Iterable of immediate "parents" to try resolving component parts.
referenceBy stops at the first parent where a part is found.
Can be cached.
no setterinherited
- relationshipsClass → String
-
The CSS class to use in an inheritance list.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- samples → String?
-
Either a URI to documentation with samples,
or 'null' if one was not declared.
no setterinherited
- scope → Scope?
-
For any
CommentReferable
where an analyzerScope
exists (or can be constructed), implement this. This will take priority over lookups via referenceChildren. Can be cached.no setterinherited - sourceCode → String
-
latefinalinherited
- sourceFileName → String
-
no setterinherited
- sourceHref → String
-
latefinalinherited
-
staticAccessors
→ Iterable<
Accessor> -
no setterinherited
-
staticFields
→ Iterable<
Field> -
no setterinherited
-
staticMethods
→ Iterable<
Method> -
no setterinherited
-
subCategoryNames
→ List<
String> ? -
Either a set of strings containing all declared subcategories for this symbol,
or 'null' if none were declared.
no setterinherited
-
superChain
→ List<
DefinedElementType> -
no setter
- supertype → DefinedElementType?
-
no setter
-
typeParameters
→ List<
TypeParameter> -
no setteroverride
-
variableStaticFields
→ Iterable<
Field> -
no setterinherited
Methods
-
buildDocumentationAddition(
String rawDocs) → String -
Override this to add more features to the documentation builder in a
subclass.
inherited
-
childLookups(
List< String> reference) → Iterable<ReferenceChildrenLookup> -
A list of lookups that should be attempted on children based on
reference
. This allows us to deal with libraries that may have separators in them.referenceBy
stops at the first one found.inherited -
compareTo(
dynamic other) → int -
Compares this object to another object.
inherited
-
containsElement(
Element? element) → bool -
This container might be canonical for elements it does not contain.
See Inheritable.canonicalEnclosingContainer.
inherited
-
injectMacros(
String rawDocs) → String -
Replace {@macro ...} in API comments with the contents of the macro
inherited
-
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.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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
-
referenceBy(
List< String> reference, {required bool filter(CommentReferable?), required bool allowTree(CommentReferable?), bool tryParents = true, Iterable<CommentReferable> ? parentOverrides}) → CommentReferable? -
Look up a comment reference by its component parts.
inherited
-
scoreCanonicalCandidates(
Iterable< Library> libraries) → List<ScoredCandidate> -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
warn(
PackageWarning kind, {String? message, Iterable< Locatable> referredFrom = const [], Iterable<String> extendedDebug = const []}) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited