StoreCommand class abstract

A command that needs a resolved CliContext.

The context is supplied by the runner rather than built per command, so a single --server/--data decision applies to the whole invocation and tests can drive commands against an in-memory store without a socket.

Inheritance

• Object
• Command<int>
• StoreCommand

Implementers

• CheckUpdateCommand
• DownloadCommand
• ProvidersCommand

Constructors

StoreCommand(Future<CliContext> contextFactory())

Creates a command over contextFactory.

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

context → Future<CliContext>

The resolved context, memoised for the command's lifetime.

no setter

contextFactory → Future<CliContext> Function()

Supplies the resolved context.

final

description → String

A description of this command, included in usage.

no setter, inherited

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

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, 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

flag(String name) → bool

Reads a flag.

metadata([String name = 'metadata']) → Map<String, String>

Parses repeated --metadata key=value options into a map.

multi(String name) → List<String>

Reads a repeatable option, with blanks dropped.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

optional(String name) → String?

Reads an optional option.

printUsage() → void

Prints the usage information for this command.

inherited

require(String name) → String

Reads a required option, raising a usage error when absent.

run() → FutureOr<int>?

Runs this command.

inherited

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