CommandBase class abstract

Inheritance

• Object
• Command<bool>
• CommandBase

Implementers

• CommandTemplateBase

Constructors

CommandBase(String cliTitle, ConsolePrinter consolePrinter)

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

argParser → ArgParser

The argument parser for this command.

no setter, override

argResults → ArgResults?

The parsed argument results for this command.

no setter, inherited

category → String

The command's category.

no setter, inherited

cliTitle → String

final

consolePrinter → ConsolePrinter

final

description → String

A description of this command, included in usage.

no setter, inherited

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

hasError ↔ bool

getter/setter pair

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<bool>?

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

no setter, inherited

runner → CommandRunner<bool>?

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

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

usageFooter → String?

An optional footer for usage.

no setter, inherited

Methods

addSubcommand(Command<bool> command) → void

Adds Command as a subcommand of this.

inherited

log(String ns, String message) → void

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

printToConsole(Object? o) → void

printUsage() → void

Prints the usage information for this command.

override

readFile(String filePath) → String

run() → FutureOr<bool>?

Runs this command.

inherited

showError(String message) → void

showErrorOptionNotProvided(String option) → void

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