ExtractCommand class

command to extract the public API of a package. This is used when, for example, the public API needs to be stored on disk

Inheritance

• Object
• Command<int>
• ExtractCommand

Constructors

ExtractCommand()

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

argParser → ArgParser

The argument parser for this command.

no setter, inherited

argResults → ArgResults?

The parsed argument results for this command.

no setter, inherited

category → String

The command's category.

no setter, inherited

description → String

A description of this command, included in usage.

no setter, override

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hidden → bool

Whether or not this command should be hidden from help listings.

no setter, inherited

includePathDependenciesExplanation → String

final, inherited

invocation → String

A single-line template for how to invoke this command (e.g. "pub get package").

no setter, inherited

name → String

The name of this command.

no setter, override

packageRefExplanation → String

final, inherited

parent → Command<int>?

The command's parent command, if this is a subcommand.

no setter, inherited

runner → CommandRunner<int>?

The command runner for this command.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subcommands → Map<String, Command<int>>

An unmodifiable view of all sublevel commands of this command.

no setter, inherited

suggestionAliases → List<String>

Alternate non-functional names for this command.

no setter, inherited

summary → String

A short description of this command, included in parent's CommandRunner.usage.

no setter, inherited

takesArguments → bool

Whether or not this command takes positional arguments in addition to options.

no setter, inherited

usage → String

Generates a string displaying usage information for this command.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, inherited

Methods

addSubcommand(Command<int> command) → void

Adds Command as a subcommand of this.

inherited

analyze(ArgResults argResults, PreparedPackageRef preparedRef, {bool doAnalyzePlatformConstraints = true, bool doRemoveExample = true}) → Future<PackageApi>

Analyzes the given prepared Package ref. doMergeBaseClasses defines if base classes should be merged into derived ones. This allows to remove private base classes from the list of interface declarations. doAnalyzePlatformConstraints defines if the platform constraints of the package shall be analyzed.

inherited

cleanUp(PreparedPackageRef preparedPackageRef) → Future

If the prepared package contains anything that has to be cleaned up (like created temp directories) then cleanUp takes care of that

inherited

init(ArgParser argParser) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

prepare(ArgResults argResults, PackageRef ref) → Future<PreparedPackageRef>

prepares given ref. Depending on the type of ref this can include

inherited

printUsage() → void

Prints the usage information for this command.

inherited

run() → Future<int>

Runs this command.

override

toString() → String

A string representation of this object.

inherited

usageException(String message) → Never

Throws a UsageException with message.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited