Mixin class

Implements the Dart 2.1 "mixin" style of mixin declarations.

Inheritance

Constructors

Mixin(ClassElement element, Library library, PackageGraph packageGraph)

Properties

allCanonicalModelElements List<ModelElement>
read-only, inherited
allElements Set<Element>
read-only, inherited
allFields List<Field>
read-only, inherited
allModelElements List<ModelElement>
read-only, inherited
allModelElementsByNamePart Map<String, List<ModelElement>>
Helper for _MarkdownCommentReference._getResultsForClass.
read-only, inherited
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
categories Iterable<Category>
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
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, inherited
constructors Iterable<Constructor>
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
declaredOperators Iterable<Operator>
@nonVirtual, read-only, inherited
defaultConstructor Constructor
@Deprecated('Renamed to `unnamedConstructor`; this getter with the old name will be ' 'removed as early as Dartdoc 1.0.0'), read-only, inherited
definingClass Class
Returns the Class with the library in which element is defined.
read-only, inherited
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 ClassElement
read-only, inherited
enclosingElement ModelElement
Returns the library that encloses this element.
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, override
filePath String
read-only, inherited
fileType String
read-only, inherited
fullkind 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
hasCategorization bool
True if categories, subcategories, a documentation icon, or samples were declared.
read-only, inherited
hasCategoryNames bool
read-only, inherited
hasDisplayedCategories 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
hasImage bool
read-only, inherited
hasInstanceFields bool
read-only, inherited
hasModifiers bool
read-only, override
hasNodoc bool
Returns true if the raw documentation comment has a nodoc indication.
read-only, inherited
hasParameters bool
read-only, inherited
hasPotentiallyApplicableExtensions bool
read-only, inherited
hasPublicConstantFields bool
read-only, inherited
hasPublicConstructors bool
Whether any constructors are public. [...]
read-only, inherited
hasPublicImplementors bool
read-only, inherited
hasPublicInheritedMethods bool
read-only, inherited
hasPublicInstanceFields bool
@nonVirtual, read-only, inherited
hasPublicInstanceMethods bool
@nonVirtual, read-only, inherited
hasPublicInstanceOperators bool
@nonVirtual, read-only, inherited
hasPublicInterfaces bool
read-only, inherited
hasPublicMixins bool
read-only, inherited
hasPublicStaticFields bool
read-only, inherited
hasPublicStaticMethods bool
read-only, inherited
hasPublicSuperChainReversed bool
read-only, inherited
hasPublicSuperclassConstraints bool
read-only
hasPublicVariableStaticFields bool
read-only, inherited
hasSamples bool
read-only, inherited
hasSourceCode bool
read-only, inherited
hasSourceHref bool
read-only, inherited
hasSubCategoryNames 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
image String
Either a URI to a defined image, or the empty string if none was declared.
read-only, inherited
inheritanceChain List<Class>
read-only, override
inheritedFields Iterable<Field>
read-only, inherited
inheritedMethods Iterable<Method>
read-only, inherited
inheritedOperators Iterable<Operator>
read-only, inherited
instanceAccessors Iterable<Accessor>
read-only, inherited
instanceFields Iterable<Field>
All fields accessible in this instance that are not static.
read-only, inherited
instanceMethods Iterable<Method>
read-only, inherited
instanceOperators Iterable<Operator>
read-only, inherited
interfaces List<DefinedElementType>
read-only, inherited
isAbstract bool
read-only, override
isAsynchronous bool
read-only, inherited
isCanonical bool
read-only, inherited
isClass bool
read-only, inherited
isConst bool
read-only, inherited
isDeprecated bool
read-only, inherited
isDocumented bool
read-only, inherited
isErrorOrException bool
read-only, inherited
isExecutable bool
read-only, inherited
isExtension bool
read-only, inherited
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, override
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
mixins List<DefinedElementType>
@Deprecated('Field intended to be final; setter will be removed as early as ' 'Dartdoc 1.0.0'), read / write, inherited
modelElementRenderer → ModelElementRenderer
@visibleForTesting, read-only, inherited
modelNode ModelNode
read-only, inherited
modelType DefinedElementType
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
potentiallyApplicableExtensions Iterable<Extension>
The set of potentiallyApplicableExtensions, for display in templates. [...]
read-only, inherited
potentiallyApplicableExtensionsSorted List<Extension>
read-only, inherited
publicConstantFields Iterable<Field>
read-only, inherited
publicConstantFieldsSorted List<Field>
read-only, inherited
publicConstructors Iterable<Constructor>
@visibleForTesting, read-only, inherited
publicConstructorsSorted List<Constructor>
read-only, inherited
publicImplementors Iterable<Class>
Returns all the "immediate" public implementors of this class. [...]
read-only, inherited
publicInheritedFields Iterable<Field>
read-only, inherited
publicInheritedInstanceFields bool
Whether all instance fields are inherited. [...]
read-only, inherited
publicInheritedInstanceMethods bool
Whether all instance methods are inherited. [...]
read-only, inherited
publicInheritedInstanceOperators Iterable<Operator>
read-only, inherited
publicInheritedMethods Iterable<Method>
read-only, inherited
publicInstanceFields Iterable<Field>
@nonVirtual, read-only, inherited
publicInstanceFieldsSorted List<Field>
read-only, inherited
publicInstanceMethods Iterable<Method>
read-only, inherited
publicInstanceMethodsSorted List<Method>
read-only, inherited
publicInstanceOperators Iterable<Operator>
@nonVirtual, read-only, inherited
publicInstanceOperatorsSorted List<Operator>
read-only, inherited
publicInterfaces Iterable<DefinedElementType>
read-only, inherited
publicMixins Iterable<DefinedElementType>
read-only, inherited
publicStaticFields Iterable<Field>
read-only, inherited
publicStaticFieldsSorted List<Field>
read-only, inherited
publicStaticMethods Iterable<Method>
read-only, inherited
publicStaticMethodsSorted List<Method>
read-only, inherited
publicSuperChain Iterable<DefinedElementType>
read-only, inherited
publicSuperChainReversed Iterable<DefinedElementType>
read-only, inherited
publicSuperclassConstraints Iterable<ParameterizedElementType>
read-only
publicVariableStaticFields Iterable<Field>
read-only, inherited
publicVariableStaticFieldsSorted List<Field>
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
samples String
Either a URI to documentation with samples, or the empty string if none was declared.
read-only, inherited
sourceCode String
read-only, inherited
sourceFileName String
read-only, inherited
sourceHref String
read-only, inherited
staticAccessors Iterable<Accessor>
read-only, inherited
staticFields Iterable<Field>
read-only, inherited
staticMethods Iterable<Method>
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
superChain List<DefinedElementType>
read-only, inherited
superclassConstraints Iterable<ParameterizedElementType>
Returns a list of superclass constraints for this mixin.
read-only
supertype DefinedElementType
@Deprecated('Field intended to be final; setter will be removed as early as ' 'Dartdoc 1.0.0'), read / write, inherited
typeParameters List<TypeParameter>
read-only, inherited
unnamedConstructor Constructor
read-only, inherited
variableStaticFields Iterable<Field>
read-only, inherited

Methods

annotationsFromMetadata(Iterable<ElementAnnotation> md) List<String>
Returns linked annotations from a given metadata set, with escaping.
inherited
buildCanonicalModelElement() ModelElement
inherited
buildDocumentationAddition(String rawDocs) 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.
inherited
isInheritingFrom(Class other) bool
@Deprecated('Public method intended to be private; will be removed as early as ' 'Dartdoc 1.0.0'), 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 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 o) bool
The equality operator. [...]
inherited