MixedInTypes mixin

Add the ability to support mixed-in types to an InheritingContainer.

Superclass Constraints
Mixin Applications

Properties

mixedInTypes List<DefinedElementType>
read-only
hasPublicMixedInTypes bool
read-only
hasModifiers bool
read-only, override
publicMixedInTypes Iterable<DefinedElementType>
read-only
supertype DefinedElementType
final, inherited
element ClassElement
ClassElement is analogous to InheritingContainer.
read-only, inherited
instanceMethods Iterable<Method>
read-only, inherited
publicInheritedInstanceMethods bool
Whether all instance methods are inherited.
read-only, inherited
instanceOperators Iterable<Operator>
read-only, inherited
publicInheritedInstanceOperators bool
Whether all instance operators are inherited.
read-only, inherited
allModelElements List<ModelElement>
read-only, inherited
definingContainer InheritingContainer
Returns the InheritingContainer with the library in which element is defined.
read-only, inherited
enclosingElement ModelElement
Returns the library that encloses this element.
read-only, inherited
filePath String
read-only, inherited
fullkind String
read-only, inherited
hasPublicSuperChainReversed bool
read-only, inherited
href String
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable subclasses) is null, href should be null.
read-only, inherited
inheritedMethods Iterable<Method>
read-only, inherited
publicInheritedMethods Iterable<Method>
read-only, inherited
hasPublicInheritedMethods bool
read-only, inherited
inheritedOperators Iterable<Operator>
read-only, inherited
inheritedFields Iterable<Field>
read-only, inherited
publicInterfaces Iterable<DefinedElementType>
read-only, inherited
publicInheritedFields Iterable<Field>
read-only, inherited
isCanonical bool
read-only, inherited
modelType DefinedElementType
read-only, inherited
inheritanceChain List<InheritingContainer>
Not the same as superChain as it may include mixins. It's really not even the same as ordinary Dart inheritance, either, because we pretend that interfaces are part of the inheritance chain to include them in the set of things we might link to for documentation purposes in abstract classes.
read-only, inherited
superChain List<DefinedElementType>
read-only, inherited
publicSuperChain Iterable<DefinedElementType>
read-only, inherited
publicSuperChainReversed Iterable<DefinedElementType>
read-only, inherited
allFields List<Field>
read-only, inherited
declaredFields Iterable<Field>
Fields fully declared in this Container.
read-only, inherited
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, inherited
typeParameters List<TypeParameter>
read-only, inherited
instanceFields Iterable<Field>
All fields accessible in this instance that are not static.
read-only, inherited
publicInheritedInstanceFields bool
Whether all instance fields are inherited.
read-only, inherited
constantFields Iterable<Field>
read-only, inherited
scope Scope
For any CommentReferable where an analyzer Scope exists (or can be constructed), implement this. This will take priority over lookups via referenceChildren. Can be cached.
read-only, inherited
hasParameters bool
read-only, inherited
isClass bool
Is this a class (but not an enum)?
read-only, inherited
isExtension bool
read-only, inherited
isClassOrExtension bool
For templates, classes and extensions have much in common despite differing underlying implementations in the analyzer.
read-only, inherited
isEnum bool
read-only, inherited
isClassOrEnum bool
read-only, inherited
isMixin bool
read-only, inherited
allCanonicalModelElements List<ModelElement>
read-only, inherited
hasPublicConstructors bool
Override if this is Constructable.
read-only, inherited
publicConstructorsSorted Iterable<Constructor>
read-only, inherited
hasPublicInstanceMethods bool
@nonVirtual, read-only, inherited
publicInstanceMethods Iterable<Method>
read-only, inherited
publicInstanceMethodsSorted List<Method>
read-only, inherited
declaredOperators Iterable<Operator>
@nonVirtual, read-only, inherited
hasPublicInstanceOperators bool
@nonVirtual, read-only, inherited
publicInstanceOperators Iterable<Operator>
@nonVirtual, read-only, inherited
publicInstanceOperatorsSorted List<Operator>
read-only, inherited
hasInstanceFields bool
read-only, inherited
publicInstanceFields Iterable<Field>
@nonVirtual, read-only, inherited
hasPublicInstanceFields bool
@nonVirtual, read-only, inherited
publicInstanceFieldsSorted List<Field>
read-only, inherited
publicConstantFields Iterable<Field>
read-only, inherited
hasPublicConstantFields bool
read-only, inherited
publicConstantFieldsSorted List<Field>
read-only, inherited
instanceAccessors Iterable<Accessor>
read-only, inherited
staticAccessors Iterable<Accessor>
read-only, inherited
allElements Set<Element>
read-only, inherited
hasPublicStaticFields bool
read-only, inherited
publicStaticFields Iterable<Field>
read-only, inherited
publicStaticFieldsSorted List<Field>
read-only, inherited
staticFields Iterable<Field>
read-only, inherited
variableStaticFields Iterable<Field>
read-only, inherited
hasPublicVariableStaticFields bool
read-only, inherited
publicVariableStaticFields Iterable<Field>
read-only, inherited
publicVariableStaticFieldsSorted List<Field>
read-only, inherited
staticMethods Iterable<Method>
read-only, inherited
hasPublicStaticMethods bool
read-only, inherited
publicStaticMethods Iterable<Method>
read-only, inherited
publicStaticMethodsSorted List<Method>
read-only, inherited
extraReferenceChildren Iterable<MapEntry<String, CommentReferable>>
For subclasses to add items after the main pass but before the parameter-global.
read-only, inherited
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. [...]
@mustCallSuper, read-only, inherited
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.
read-only, inherited
hasCategoryNames bool
read-only, inherited
displayedCategories Iterable<Category>
read-only, inherited
exportedInLibraries Set<Library>
read-only, inherited
modelNode ModelNode
read-only, inherited
annotations Iterable<Annotation>
read-only, inherited
isPublic bool
read-only, inherited
commentRefs Map<String, ModelCommentReference>
A map of ModelCommentReference.codeRef to ModelCommentReference. This map deduplicates comment references as all identical reference strings inside a single documentation comment will point to the same place, so it should not be used to count exactly how many references there are.
read-only, inherited
config DartdocOptionContext
read-only, inherited
locationPieces Set<String>
Pieces of the location, split to remove 'package:' and slashes.
read-only, inherited
hasFeatures bool
read-only, inherited
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. See Feature for a list.
read-only, inherited
featuresAsString String
read-only, inherited
isCallable bool
read-only, inherited
canonicalModelElement ModelElement
read-only, inherited
hasSourceHref bool
read-only, inherited
sourceHref String
read-only, inherited
definingLibrary Library
read-only, inherited
canonicalLibrary Library
read-only, inherited
documentation String
Returns the docs, stripped of their leading comments syntax.
read-only, inherited
location String
A string indicating the URI of this Locatable, usually derived from Element.location.
read-only, inherited
Returns a link to extended documentation, or the empty string if that does not exist.
read-only, inherited
fileName String
read-only, inherited
fileType String
read-only, inherited
fullyQualifiedName String
Returns the fully qualified name. [...]
read-only, inherited
fullyQualifiedNameWithoutLibrary String
read-only, inherited
sourceFileName String
read-only, inherited
characterLocation CharacterLocation
read-only, inherited
compilationUnitElement CompilationUnitElement
read-only, inherited
hasAnnotations bool
read-only, inherited
hasDocumentation bool
read-only, inherited
hasExtendedDocumentation bool
read-only, inherited
htmlId String
read-only, inherited
isAsynchronous bool
read-only, inherited
isConst bool
read-only, inherited
isDeprecated bool
read-only, inherited
isDocumented bool
read-only, inherited
isExecutable bool
read-only, inherited
isFinal bool
read-only, inherited
isLate bool
read-only, inherited
isLocalElement bool
read-only, inherited
isPropertyAccessor bool
read-only, inherited
isPropertyInducer 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
linkedName String
read-only, inherited
modelElementRenderer → ModelElementRenderer
@visibleForTesting, read-only, inherited
linkedParams String
read-only, inherited
linkedParamsLines String
read-only, inherited
linkedParamsNoMetadata String
read-only, inherited
linkedParamsNoMetadataOrNames String
read-only, inherited
name String
read-only, inherited
oneLineDoc String
read-only, inherited
originalMember → Member
read-only, inherited
packageGraph PackageGraph
read / write, inherited
package Package
read-only, inherited
isPublicAndPackageDocumented bool
read-only, inherited
allParameters List<Parameter>
read-only, inherited
pathContext Context
read-only, inherited
parameters List<Parameter>
read-only, inherited
documentationComment String
read-only, inherited
hasDocumentationComment bool
True if this has a synthetic/inherited or local documentation comment. False otherwise.
read-only, inherited
sourceCode String
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
documentationFrom List<DocumentationComment>
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
documentationIsLocal bool
True if documentationFrom contains only one item, this.
read-only, inherited
documentationAsHtml String
read-only, inherited
namePieces Set<String>
read-only, inherited
namePart String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
read-only, inherited
referenceGrandparentOverrides Iterable<CommentReferable>
Replace the parents of parents. referenceBy ignores whatever might otherwise be implied by the referenceParents of referenceParents, replacing them with this.
read-only, inherited
referenceName String
read-only, inherited
hasSourceCode bool
read-only, inherited
overriddenDepth int
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
hasFeatureSet bool
read-only, inherited
isNullSafety bool
read-only, inherited
elementDocumentation Documentation
read-only, inherited
hasNodoc bool
Returns true if the raw documentation comment has a nodoc indication.
read-only, inherited
documentationLocal String
read-only, inherited
needsPrecache bool
read-only, inherited
hasSubCategoryNames bool
read-only, inherited
subCategoryNames List<String>
Either a set of strings containing all declared subcategories for this symbol, or a set containing Null if none were declared.
read-only, inherited
categoryNames List<String>
Either a set of strings containing all declared categories for this symbol, or a set containing Null if none were declared.
read-only, inherited
hasImage bool
read-only, inherited
image String
Either a URI to a defined image, or the empty string if none was declared.
read-only, inherited
hasSamples bool
read-only, inherited
samples String
Either a URI to documentation with samples, or the empty string if none was declared.
read-only, inherited
categories Iterable<Category>
read-only, inherited
hasCategorization bool
True if categories, subcategories, a documentation icon, or samples were declared.
read-only, inherited
nameWithGenerics String
read-only, inherited
nameWithLinkedGenerics String
read-only, inherited
hasGenericParameters bool
read-only, inherited
genericParameters String
read-only, inherited
linkedGenericParameters String
read-only, inherited
hasPotentiallyApplicableExtensions bool
read-only, inherited
potentiallyApplicableExtensions Iterable<Extension>
The set of potentiallyApplicableExtensions, for display in templates. [...]
read-only, inherited
potentiallyApplicableExtensionsSorted List<Extension>
read-only, inherited

Methods

containsElement(Element element) bool
This container might be canonical for elements it does not contain. See Inheritable.canonicalEnclosingContainer.
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
buildCanonicalModelElement() ModelElement
inherited
compareTo(dynamic other) int
Compares this object to another object. [...]
inherited
toString() String
A string representation of this object. [...]
inherited
scoreCanonicalCandidates(Iterable<Library> libraries) List<ScoredCandidate>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
referenceBy(List<String> reference, {bool tryParents = true, bool filter(CommentReferable), bool allowTree(CommentReferable), Iterable<CommentReferable> parentOverrides}) → CommentReferable
Look up a comment reference by its component parts. If tryParents is true, try looking up the same reference in any parents of this. Will skip over results that do not pass a given filter and keep searching. Will skip over entire subtrees whose parent node does not pass allowTree.
@nonVirtual, inherited
lookupViaScope(ReferenceChildrenLookup referenceLookup, bool allowTree(CommentReferable), bool filter(CommentReferable)) → CommentReferable
Looks up references by scope, skipping over results that do not match the given filter. [...]
inherited
recurseChildrenAndFilter(ReferenceChildrenLookup referenceLookup, CommentReferable result, {bool allowTree(CommentReferable), bool filter(CommentReferable)}) → CommentReferable
Given a result found in an implementation of lookupViaScope or _lookupViaReferenceChildren, recurse through children, skipping over results that do not match the filter.
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
warn(PackageWarning kind, {String message, Iterable<Locatable> referredFrom, Iterable<String> extendedDebug}) → void
inherited
processComment(String documentationComment) Future<String>
Process documentationComment, performing various actions based on {@}-style directives, returning the processed result.
@visibleForTesting, inherited
processCommentDirectives(String docs) String
inherited
precacheLocalDocs() Future<void>
Unconditionally precache local documentation. [...]
inherited
buildDocumentationAddition(String rawDocs) String
Override this to add more features to the documentation builder in a subclass.
inherited
injectMacros(String rawDocs) String
Replace {@macro ...} in API comments with the contents of the macro [...]
inherited

Operators

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