| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="API docs for the CommandRunner class from the command_runner library, for the Dart programming language."> |
| <title>CommandRunner class - command_runner library - Dart API</title> |
| <!-- required because all the links are pseudo-absolute --> |
| <base href=".."> |
| |
| <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet"> |
| <link rel="stylesheet" href="static-assets/github.css"> |
| <link rel="stylesheet" href="static-assets/styles.css"> |
| <link rel="icon" href="static-assets/favicon.png"> |
| |
| </head> |
| |
| <body> |
| |
| <div id="overlay-under-drawer"></div> |
| |
| <header id="title"> |
| <button id="sidenav-left-toggle" type="button"> </button> |
| <ol class="breadcrumbs gt-separated dark hidden-xs"> |
| <li><a href="index.html">test_package</a></li> |
| <li><a href="package-args_command_runner/package-args_command_runner-library.html">command_runner</a></li> |
| <li class="self-crumb">CommandRunner<span class="signature"><<wbr><span class="type-parameter">T</span>></span> class</li> |
| </ol> |
| <div class="self-name">CommandRunner</div> |
| <form class="search navbar-right" role="search"> |
| <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search..."> |
| </form> |
| </header> |
| |
| <main> |
| |
| <div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"> |
| <h5>command_runner library</h5> |
| <ol> |
| <li class="section-title"><a href="package-args_command_runner/package-args_command_runner-library.html#classes">Classes</a></li> |
| <li><a href="package-args_command_runner/Command-class.html">Command</a></li> |
| <li><a href="package-args_command_runner/CommandRunner-class.html">CommandRunner</a></li> |
| |
| |
| |
| |
| |
| |
| <li class="section-title"><a href="package-args_command_runner/package-args_command_runner-library.html#exceptions">Exceptions</a></li> |
| <li><a href="package-args_command_runner/UsageException-class.html">UsageException</a></li> |
| </ol> |
| </div> |
| |
| <div class="col-xs-12 col-sm-9 col-md-8 main-content"> |
| <h1>CommandRunner<<wbr><span class="type-parameter">T</span>> class </h1> |
| |
| <section class="desc markdown"> |
| <p>A class for invoking <a href="package-args_command_runner/Command-class.html">Command</a>s based on raw command-line arguments.</p> |
| <p>The type argument <code>T</code> represents the type returned by <a href="package-args_command_runner/Command/run.html">Command.run</a> and |
| <a href="package-args_command_runner/CommandRunner/run.html">CommandRunner.run</a>; it can be ommitted if you're not using the return |
| values.</p> |
| </section> |
| |
| |
| <section class="summary offset-anchor" id="constructors"> |
| <h2>Constructors</h2> |
| |
| <dl class="constructor-summary-list"> |
| <dt id="CommandRunner" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/CommandRunner.html">CommandRunner</a></span><span class="signature">(<span class="parameter" id="-param-executableName"><span class="type-annotation">String</span> <span class="parameter-name">executableName</span>, </span> <span class="parameter" id="-param-description"><span class="type-annotation">String</span> <span class="parameter-name">description</span></span>)</span> |
| </dt> |
| <dd> |
| |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="instance-properties"> |
| <h2>Properties</h2> |
| |
| <dl class="properties"> |
| <dt id="argParser" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/argParser.html">argParser</a></span> |
| <span class="signature">→ <a href="package-args_args/ArgParser-class.html">ArgParser</a></span> |
| </dt> |
| <dd> |
| The top-level argument parser. <a href="package-args_command_runner/CommandRunner/argParser.html">[...]</a> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="commands" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/commands.html">commands</a></span> |
| <span class="signature">→ Map<span class="signature"><<wbr><span class="type-parameter">String</span>, <span class="type-parameter"><a href="package-args_command_runner/Command-class.html">Command</a><span class="signature"><<wbr><span class="type-parameter">T</span>></span></span>></span></span> |
| </dt> |
| <dd> |
| An unmodifiable view of all top-level commands defined for this runner. |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="description" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/description.html">description</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| A short description of this executable. |
| <div class="features">final</div> |
| </dd> |
| <dt id="executableName" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/executableName.html">executableName</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| The name of the executable being run. <a href="package-args_command_runner/CommandRunner/executableName.html">[...]</a> |
| <div class="features">final</div> |
| </dd> |
| <dt id="invocation" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/invocation.html">invocation</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| A single-line template for how to invoke this executable. <a href="package-args_command_runner/CommandRunner/invocation.html">[...]</a> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="usage" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/usage.html">usage</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| Generates a string displaying usage information for the executable. <a href="package-args_command_runner/CommandRunner/usage.html">[...]</a> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="usageFooter" class="property"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/usageFooter.html">usageFooter</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| An optional footer for <a href="package-args_command_runner/CommandRunner/usage.html">usage</a>. <a href="package-args_command_runner/CommandRunner/usageFooter.html">[...]</a> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="hashCode" class="property inherited"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/hashCode.html">hashCode</a></span> |
| <span class="signature">→ int</span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">read-only, inherited</div> |
| </dd> |
| <dt id="runtimeType" class="property inherited"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/runtimeType.html">runtimeType</a></span> |
| <span class="signature">→ Type</span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">read-only, inherited</div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="instance-methods"> |
| <h2>Methods</h2> |
| <dl class="callables"> |
| <dt id="addCommand" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/addCommand.html">addCommand</a></span><span class="signature">(<wbr><span class="parameter" id="addCommand-param-command"><span class="type-annotation"><a href="package-args_command_runner/Command-class.html">Command</a><span class="signature"><<wbr><span class="type-parameter">T</span>></span></span> <span class="parameter-name">command</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Adds <a href="package-args_command_runner/Command-class.html">Command</a> as a top-level command to this runner. |
| |
| </dd> |
| <dt id="parse" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/parse.html">parse</a></span><span class="signature">(<wbr><span class="parameter" id="parse-param-args"><span class="type-annotation">Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">args</span></span>) |
| <span class="returntype parameter">→ <a href="package-args_args/ArgResults-class.html">ArgResults</a></span> |
| </span> |
| </dt> |
| <dd> |
| Parses <code>args</code> and returns the result, converting an <a href="package-args_args/ArgParserException-class.html">ArgParserException</a> |
| to a <a href="package-args_command_runner/UsageException-class.html">UsageException</a>. <a href="package-args_command_runner/CommandRunner/parse.html">[...]</a> |
| |
| </dd> |
| <dt id="printUsage" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/printUsage.html">printUsage</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Prints the usage information for this runner. <a href="package-args_command_runner/CommandRunner/printUsage.html">[...]</a> |
| |
| </dd> |
| <dt id="run" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/run.html">run</a></span><span class="signature">(<wbr><span class="parameter" id="run-param-args"><span class="type-annotation">Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">args</span></span>) |
| <span class="returntype parameter">→ Future<span class="signature"><<wbr><span class="type-parameter">T</span>></span></span> |
| </span> |
| </dt> |
| <dd> |
| Parses <code>args</code> and invokes <a href="package-args_command_runner/Command/run.html">Command.run</a> on the chosen command. <a href="package-args_command_runner/CommandRunner/run.html">[...]</a> |
| |
| </dd> |
| <dt id="runCommand" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/runCommand.html">runCommand</a></span><span class="signature">(<wbr><span class="parameter" id="runCommand-param-topLevelResults"><span class="type-annotation"><a href="package-args_args/ArgResults-class.html">ArgResults</a></span> <span class="parameter-name">topLevelResults</span></span>) |
| <span class="returntype parameter">→ Future<span class="signature"><<wbr><span class="type-parameter">T</span>></span></span> |
| </span> |
| </dt> |
| <dd> |
| Runs the command specified by <code>topLevelResults</code>. <a href="package-args_command_runner/CommandRunner/runCommand.html">[...]</a> |
| |
| </dd> |
| <dt id="usageException" class="callable"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/usageException.html">usageException</a></span><span class="signature">(<wbr><span class="parameter" id="usageException-param-message"><span class="type-annotation">String</span> <span class="parameter-name">message</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Throws a <a href="package-args_command_runner/UsageException-class.html">UsageException</a> with <code>message</code>. |
| |
| </dd> |
| <dt id="noSuchMethod" class="callable inherited"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation">Invocation</span> <span class="parameter-name">invocation</span></span>) |
| <span class="returntype parameter">→ dynamic</span> |
| </span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">inherited</div> |
| </dd> |
| <dt id="toString" class="callable inherited"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/toString.html">toString</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ String</span> |
| </span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">inherited</div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor inherited" id="operators"> |
| <h2>Operators</h2> |
| <dl class="callables"> |
| <dt id="operator ==" class="callable inherited"> |
| <span class="name"><a href="package-args_command_runner/CommandRunner/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span>) |
| <span class="returntype parameter">→ bool</span> |
| </span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">inherited</div> |
| </dd> |
| </dl> |
| </section> |
| |
| |
| |
| |
| </div> <!-- /.main-content --> |
| |
| <div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"> |
| <ol> |
| <li class="section-title"><a href="package-args_command_runner/CommandRunner-class.html#constructors">Constructors</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/CommandRunner.html">CommandRunner</a></li> |
| |
| <li class="section-title"> |
| <a href="package-args_command_runner/CommandRunner-class.html#instance-properties">Properties</a> |
| </li> |
| <li><a href="package-args_command_runner/CommandRunner/argParser.html">argParser</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/commands.html">commands</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/description.html">description</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/executableName.html">executableName</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/invocation.html">invocation</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/usage.html">usage</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/usageFooter.html">usageFooter</a></li> |
| <li class="inherited"><a href="package-args_command_runner/CommandRunner/hashCode.html">hashCode</a></li> |
| <li class="inherited"><a href="package-args_command_runner/CommandRunner/runtimeType.html">runtimeType</a></li> |
| |
| <li class="section-title"><a href="package-args_command_runner/CommandRunner-class.html#instance-methods">Methods</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/addCommand.html">addCommand</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/parse.html">parse</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/printUsage.html">printUsage</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/run.html">run</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/runCommand.html">runCommand</a></li> |
| <li><a href="package-args_command_runner/CommandRunner/usageException.html">usageException</a></li> |
| <li class="inherited"><a href="package-args_command_runner/CommandRunner/noSuchMethod.html">noSuchMethod</a></li> |
| <li class="inherited"><a href="package-args_command_runner/CommandRunner/toString.html">toString</a></li> |
| |
| <li class="section-title inherited"><a href="package-args_command_runner/CommandRunner-class.html#operators">Operators</a></li> |
| <li class="inherited"><a href="package-args_command_runner/CommandRunner/operator_equals.html">operator ==</a></li> |
| |
| |
| |
| </ol> |
| </div><!--/.sidebar-offcanvas--> |
| |
| </main> |
| |
| <footer> |
| <span class="no-break"> |
| test_package 0.0.1 |
| </span> |
| |
| </footer> |
| |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script> |
| <script src="static-assets/typeahead.bundle.min.js"></script> |
| <script src="static-assets/highlight.pack.js"></script> |
| <script src="static-assets/URI.js"></script> |
| <script src="static-assets/script.js"></script> |
| |
| |
| </body> |
| |
| </html> |
