Commands class

Inheritance

• Object
• CommandRunner<void>
• Commands

Constructors

Commands(String executableName, String description)

Properties

argParser → ArgParser

The top-level argument parser.

no setter, inherited

commands → Map<String, Command<void>>

An unmodifiable view of all top-level commands defined for this runner.

no setter, inherited

description → String

A short description of this executable.

final, inherited

executableName → String

The name of the executable being run.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

invocation → String

A single-line template for how to invoke this executable.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

suggestionDistanceLimit → int

The maximum edit distance allowed when suggesting possible intended commands.

final, inherited

usage → String

Generates a string displaying usage information for the executable.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, inherited

Methods

addCommand(Command<void> command) → void

Adds Command as a top-level command to this runner.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

parse(Iterable<String> args) → ArgResults

Parses args and returns the result, converting an ArgParserException to a UsageException.

inherited

printUsage() → void

Prints the usage information for this runner.

inherited

run(Iterable<String> args) → Future<void>

Parses args and invokes Command.run on the chosen command.

inherited

runCommand(ArgResults topLevelResults) → Future<void>

Runs the command specified by topLevelResults.

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