PackageMeta abstract#

Describes a single package in the context of dartdoc.

The primary function of this class is to allow canonicalization of packages by returning the same PackageMeta for a given filename, library or path if they belong to the same package.

Overriding this is typically done by overriding factories as rest of dartdoc creates this object by calling these static factories.

Constructors#

PackageMeta()#

PackageMeta(this.dir, this.resourceProvider);

Properties#

description no setter#

The package description from pubspec.yaml, or an empty string if not available.

String get description;

dir final#

final Folder dir;

hashCode no setter override#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

@override
int get hashCode => _pathContext.hash(_pathContext.absolute(dir.path));

homepage no setter#

String get homepage;

hostedAt no setter#

The hostname that the package is hosted at, usually 'pub.dev', or null if not a hosted pub package.

String? get hostedAt;

isSdk no setter#

Whether this represents a 'Dart' SDK.

A package can be part of Dart and Flutter at the same time, but if this is part of a Dart SDK, sdkType should never return null.

bool get isSdk;

isValid no setter#

Whether this is a valid package (valid enough to generate docs).

bool get isValid => getInvalidReasons().isEmpty;

name no setter#

String get name;

repository no setter#

String get repository;

requiresFlutter no setter#

bool get requiresFlutter;

resolvedDir no setter#

String get resolvedDir;

resourceProvider final#

final ResourceProvider resourceProvider;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

version no setter#

String get version;

Methods#

getInvalidReasons()#

The list of reasons this package is invalid.

If the list is empty, this package is valid.

List<String> getInvalidReasons();

getReadmeContents()#

File? getReadmeContents();

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

sdkType()#

Returns 'Dart' or 'Flutter' (preferentially, 'Flutter' when the answer is "both"), or null if this package is not part of an SDK.

String? sdkType(String? flutterRootPath);

toString() override#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

@override
String toString() => name;

Operators#

operator ==() override#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

@override
bool operator ==(Object other) =>
    other is PackageMeta && _pathContext.equals(dir.path, other.dir.path);