| <!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 ArgParser class from the args library, for the Dart programming language."> |
| <title>ArgParser class - args 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_args/package-args_args-library.html">args</a></li> |
| <li class="self-crumb">ArgParser class</li> |
| </ol> |
| <div class="self-name">ArgParser</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>args library</h5> |
| <ol> |
| <li class="section-title"><a href="package-args_args/package-args_args-library.html#classes">Classes</a></li> |
| <li><a href="package-args_args/ArgParser-class.html">ArgParser</a></li> |
| <li><a href="package-args_args/ArgResults-class.html">ArgResults</a></li> |
| <li><a href="package-args_args/Option-class.html">Option</a></li> |
| <li><a href="package-args_args/OptionType-class.html">OptionType</a></li> |
| |
| |
| |
| |
| |
| |
| <li class="section-title"><a href="package-args_args/package-args_args-library.html#exceptions">Exceptions</a></li> |
| <li><a href="package-args_args/ArgParserException-class.html">ArgParserException</a></li> |
| </ol> |
| </div> |
| |
| <div class="col-xs-12 col-sm-9 col-md-8 main-content"> |
| <h1>ArgParser class </h1> |
| |
| <section class="desc markdown"> |
| <p>A class for taking a list of raw command line arguments and parsing out |
| options and flags from them.</p> |
| </section> |
| |
| |
| <section class="summary offset-anchor" id="constructors"> |
| <h2>Constructors</h2> |
| |
| <dl class="constructor-summary-list"> |
| <dt id="ArgParser" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/ArgParser.html">ArgParser</a></span><span class="signature">({<span class="parameter" id="-param-allowTrailingOptions"><span class="type-annotation">bool</span> <span class="parameter-name">allowTrailingOptions</span>: <span class="default-value">true</span>, </span> <span class="parameter" id="-param-usageLineLength"><span class="type-annotation">int</span> <span class="parameter-name">usageLineLength</span></span> })</span> |
| </dt> |
| <dd> |
| Creates a new ArgParser. <a href="package-args_args/ArgParser/ArgParser.html">[...]</a> |
| <div class="constructor-modifier features">factory</div> |
| </dd> |
| <dt id="ArgParser.allowAnything" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/ArgParser.allowAnything.html">ArgParser.allowAnything</a></span><span class="signature">()</span> |
| </dt> |
| <dd> |
| Creates a new ArgParser that treats <em>all input</em> as non-option arguments. <a href="package-args_args/ArgParser/ArgParser.allowAnything.html">[...]</a> |
| <div class="constructor-modifier features">factory</div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="instance-properties"> |
| <h2>Properties</h2> |
| |
| <dl class="properties"> |
| <dt id="allowsAnything" class="property"> |
| <span class="name"><a href="package-args_args/ArgParser/allowsAnything.html">allowsAnything</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether or not this parser treats unrecognized options as non-option |
| arguments. |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="allowTrailingOptions" class="property"> |
| <span class="name"><a href="package-args_args/ArgParser/allowTrailingOptions.html">allowTrailingOptions</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether or not this parser parses options that appear after non-option |
| arguments. |
| <div class="features">final</div> |
| </dd> |
| <dt id="commands" class="property"> |
| <span class="name"><a href="package-args_args/ArgParser/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_args/ArgParser-class.html">ArgParser</a></span>></span></span> |
| </dt> |
| <dd> |
| The commands that have been defined for this parser. |
| <div class="features">final</div> |
| </dd> |
| <dt id="options" class="property"> |
| <span class="name"><a href="package-args_args/ArgParser/options.html">options</a></span> |
| <span class="signature">→ Map<span class="signature"><<wbr><span class="type-parameter">String</span>, <span class="type-parameter"><a href="package-args_args/Option-class.html">Option</a></span>></span></span> |
| </dt> |
| <dd> |
| The options that have been defined for this parser. |
| <div class="features">final</div> |
| </dd> |
| <dt id="usage" class="property"> |
| <span class="name"><a href="package-args_args/ArgParser/usage.html">usage</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| Generates a string displaying usage information for the defined options. <a href="package-args_args/ArgParser/usage.html">[...]</a> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="usageLineLength" class="property"> |
| <span class="name"><a href="package-args_args/ArgParser/usageLineLength.html">usageLineLength</a></span> |
| <span class="signature">→ int</span> |
| </dt> |
| <dd> |
| An optional maximum line length for <code>usage</code> messages. <a href="package-args_args/ArgParser/usageLineLength.html">[...]</a> |
| <div class="features">final</div> |
| </dd> |
| <dt id="hashCode" class="property inherited"> |
| <span class="name"><a href="package-args_args/ArgParser/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_args/ArgParser/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_args/ArgParser/addCommand.html">addCommand</a></span><span class="signature">(<wbr><span class="parameter" id="addCommand-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span>, [</span> <span class="parameter" id="addCommand-param-parser"><span class="type-annotation"><a href="package-args_args/ArgParser-class.html">ArgParser</a></span> <span class="parameter-name">parser</span></span> ]) |
| <span class="returntype parameter">→ <a href="package-args_args/ArgParser-class.html">ArgParser</a></span> |
| </span> |
| </dt> |
| <dd> |
| Defines a command. <a href="package-args_args/ArgParser/addCommand.html">[...]</a> |
| |
| </dd> |
| <dt id="addFlag" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/addFlag.html">addFlag</a></span><span class="signature">(<wbr><span class="parameter" id="addFlag-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span>, {</span> <span class="parameter" id="addFlag-param-abbr"><span class="type-annotation">String</span> <span class="parameter-name">abbr</span>, </span> <span class="parameter" id="addFlag-param-help"><span class="type-annotation">String</span> <span class="parameter-name">help</span>, </span> <span class="parameter" id="addFlag-param-defaultsTo"><span class="type-annotation">bool</span> <span class="parameter-name">defaultsTo</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="addFlag-param-negatable"><span class="type-annotation">bool</span> <span class="parameter-name">negatable</span>: <span class="default-value">true</span>, </span> <span class="parameter" id="addFlag-param-callback"><span class="type-annotation">void</span> <span class="parameter-name">callback</span>(<span class="parameter" id="callback-param-value"><span class="type-annotation">bool</span> <span class="parameter-name">value</span></span>), </span> <span class="parameter" id="addFlag-param-hide"><span class="type-annotation">bool</span> <span class="parameter-name">hide</span>: <span class="default-value">false</span></span> }) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Defines a boolean flag. <a href="package-args_args/ArgParser/addFlag.html">[...]</a> |
| |
| </dd> |
| <dt id="addMultiOption" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/addMultiOption.html">addMultiOption</a></span><span class="signature">(<wbr><span class="parameter" id="addMultiOption-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span>, {</span> <span class="parameter" id="addMultiOption-param-abbr"><span class="type-annotation">String</span> <span class="parameter-name">abbr</span>, </span> <span class="parameter" id="addMultiOption-param-help"><span class="type-annotation">String</span> <span class="parameter-name">help</span>, </span> <span class="parameter" id="addMultiOption-param-valueHelp"><span class="type-annotation">String</span> <span class="parameter-name">valueHelp</span>, </span> <span class="parameter" id="addMultiOption-param-allowed"><span class="type-annotation">Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">allowed</span>, </span> <span class="parameter" id="addMultiOption-param-allowedHelp"><span class="type-annotation">Map<span class="signature"><<wbr><span class="type-parameter">String</span>, <span class="type-parameter">String</span>></span></span> <span class="parameter-name">allowedHelp</span>, </span> <span class="parameter" id="addMultiOption-param-defaultsTo"><span class="type-annotation">Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">defaultsTo</span>, </span> <span class="parameter" id="addMultiOption-param-callback"><span class="type-annotation">void</span> <span class="parameter-name">callback</span>(<span class="parameter" id="callback-param-values"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">values</span></span>), </span> <span class="parameter" id="addMultiOption-param-splitCommas"><span class="type-annotation">bool</span> <span class="parameter-name">splitCommas</span>: <span class="default-value">true</span>, </span> <span class="parameter" id="addMultiOption-param-hide"><span class="type-annotation">bool</span> <span class="parameter-name">hide</span>: <span class="default-value">false</span></span> }) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Defines an option that takes multiple values. <a href="package-args_args/ArgParser/addMultiOption.html">[...]</a> |
| |
| </dd> |
| <dt id="addOption" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/addOption.html">addOption</a></span><span class="signature">(<wbr><span class="parameter" id="addOption-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span>, {</span> <span class="parameter" id="addOption-param-abbr"><span class="type-annotation">String</span> <span class="parameter-name">abbr</span>, </span> <span class="parameter" id="addOption-param-help"><span class="type-annotation">String</span> <span class="parameter-name">help</span>, </span> <span class="parameter" id="addOption-param-valueHelp"><span class="type-annotation">String</span> <span class="parameter-name">valueHelp</span>, </span> <span class="parameter" id="addOption-param-allowed"><span class="type-annotation">Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">allowed</span>, </span> <span class="parameter" id="addOption-param-allowedHelp"><span class="type-annotation">Map<span class="signature"><<wbr><span class="type-parameter">String</span>, <span class="type-parameter">String</span>></span></span> <span class="parameter-name">allowedHelp</span>, </span> <span class="parameter" id="addOption-param-defaultsTo"><span class="type-annotation">String</span> <span class="parameter-name">defaultsTo</span>, </span> <span class="parameter" id="addOption-param-callback"><span class="type-annotation">Function</span> <span class="parameter-name">callback</span>, </span> <span class="parameter" id="addOption-param-allowMultiple"><span class="type-annotation">bool</span> <span class="parameter-name">allowMultiple</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="addOption-param-splitCommas"><span class="type-annotation">bool</span> <span class="parameter-name">splitCommas</span>, </span> <span class="parameter" id="addOption-param-hide"><span class="type-annotation">bool</span> <span class="parameter-name">hide</span>: <span class="default-value">false</span></span> }) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Defines an option that takes a value. <a href="package-args_args/ArgParser/addOption.html">[...]</a> |
| |
| </dd> |
| <dt id="addSeparator" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/addSeparator.html">addSeparator</a></span><span class="signature">(<wbr><span class="parameter" id="addSeparator-param-text"><span class="type-annotation">String</span> <span class="parameter-name">text</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| Adds a separator line to the usage. <a href="package-args_args/ArgParser/addSeparator.html">[...]</a> |
| |
| </dd> |
| <dt id="findByAbbreviation" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/findByAbbreviation.html">findByAbbreviation</a></span><span class="signature">(<wbr><span class="parameter" id="findByAbbreviation-param-abbr"><span class="type-annotation">String</span> <span class="parameter-name">abbr</span></span>) |
| <span class="returntype parameter">→ <a href="package-args_args/Option-class.html">Option</a></span> |
| </span> |
| </dt> |
| <dd> |
| Finds the option whose abbreviation is <code>abbr</code>, or <code>null</code> if no option has |
| that abbreviation. |
| |
| </dd> |
| <dt id="getDefault" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/getDefault.html">getDefault</a></span><span class="signature">(<wbr><span class="parameter" id="getDefault-param-option"><span class="type-annotation">String</span> <span class="parameter-name">option</span></span>) |
| <span class="returntype parameter">→ dynamic</span> |
| </span> |
| </dt> |
| <dd> |
| Get the default value for an option. Useful after parsing to test if the |
| user specified something other than the default. |
| |
| </dd> |
| <dt id="getUsage" class="callable"> |
| <span class="name deprecated"><a class="deprecated" href="package-args_args/ArgParser/getUsage.html">getUsage</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ String</span> |
| </span> |
| </dt> |
| <dd> |
| Generates a string displaying usage information for the defined options. <a href="package-args_args/ArgParser/getUsage.html">[...]</a> |
| <div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>("Replaced with get usage. getUsage() will be removed in args 1.0")</div> |
| </dd> |
| <dt id="parse" class="callable"> |
| <span class="name"><a href="package-args_args/ArgParser/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>, a list of command-line arguments, matches them against the |
| flags and options defined by this parser, and returns the result. |
| |
| </dd> |
| <dt id="noSuchMethod" class="callable inherited"> |
| <span class="name"><a href="package-args_args/ArgParser/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_args/ArgParser/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_args/ArgParser/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_args/ArgParser-class.html#constructors">Constructors</a></li> |
| <li><a href="package-args_args/ArgParser/ArgParser.html">ArgParser</a></li> |
| <li><a href="package-args_args/ArgParser/ArgParser.allowAnything.html">allowAnything</a></li> |
| |
| <li class="section-title"> |
| <a href="package-args_args/ArgParser-class.html#instance-properties">Properties</a> |
| </li> |
| <li><a href="package-args_args/ArgParser/allowsAnything.html">allowsAnything</a></li> |
| <li><a href="package-args_args/ArgParser/allowTrailingOptions.html">allowTrailingOptions</a></li> |
| <li><a href="package-args_args/ArgParser/commands.html">commands</a></li> |
| <li><a href="package-args_args/ArgParser/options.html">options</a></li> |
| <li><a href="package-args_args/ArgParser/usage.html">usage</a></li> |
| <li><a href="package-args_args/ArgParser/usageLineLength.html">usageLineLength</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/hashCode.html">hashCode</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/runtimeType.html">runtimeType</a></li> |
| |
| <li class="section-title"><a href="package-args_args/ArgParser-class.html#instance-methods">Methods</a></li> |
| <li><a href="package-args_args/ArgParser/addCommand.html">addCommand</a></li> |
| <li><a href="package-args_args/ArgParser/addFlag.html">addFlag</a></li> |
| <li><a href="package-args_args/ArgParser/addMultiOption.html">addMultiOption</a></li> |
| <li><a href="package-args_args/ArgParser/addOption.html">addOption</a></li> |
| <li><a href="package-args_args/ArgParser/addSeparator.html">addSeparator</a></li> |
| <li><a href="package-args_args/ArgParser/findByAbbreviation.html">findByAbbreviation</a></li> |
| <li><a href="package-args_args/ArgParser/getDefault.html">getDefault</a></li> |
| <li><a class="deprecated" href="package-args_args/ArgParser/getUsage.html">getUsage</a></li> |
| <li><a href="package-args_args/ArgParser/parse.html">parse</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/noSuchMethod.html">noSuchMethod</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/toString.html">toString</a></li> |
| |
| <li class="section-title inherited"><a href="package-args_args/ArgParser-class.html#operators">Operators</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/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> |
