| <!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 Option class from the args library, for the Dart programming language."> |
| <title>Option 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">Option class</li> |
| </ol> |
| <div class="self-name">Option</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>Option class </h1> |
| |
| <section class="desc markdown"> |
| <p>A command-line option.</p> |
| <p>This represents both boolean flags and options which take a value.</p> |
| </section> |
| |
| |
| |
| <section class="summary offset-anchor" id="instance-properties"> |
| <h2>Properties</h2> |
| |
| <dl class="properties"> |
| <dt id="abbr" class="property"> |
| <span class="name"><a href="package-args_args/Option/abbr.html">abbr</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| A single-character string that can be used as a shorthand for this option. <a href="package-args_args/Option/abbr.html">[...]</a> |
| <div class="features">final</div> |
| </dd> |
| <dt id="abbreviation" class="property"> |
| <span class="name"><a class="deprecated" href="package-args_args/Option/abbreviation.html">abbreviation</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| |
| <div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>('Use abbr instead.'), read-only</div> |
| </dd> |
| <dt id="allowed" class="property"> |
| <span class="name"><a href="package-args_args/Option/allowed.html">allowed</a></span> |
| <span class="signature">→ List<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> |
| </dt> |
| <dd> |
| A list of valid values for this option. |
| <div class="features">final</div> |
| </dd> |
| <dt id="allowedHelp" class="property"> |
| <span class="name"><a href="package-args_args/Option/allowedHelp.html">allowedHelp</a></span> |
| <span class="signature">→ Map<span class="signature"><<wbr><span class="type-parameter">String</span>, <span class="type-parameter">String</span>></span></span> |
| </dt> |
| <dd> |
| A map from values in <code>allowed</code> to documentation for those values. |
| <div class="features">final</div> |
| </dd> |
| <dt id="callback" class="property"> |
| <span class="name"><a href="package-args_args/Option/callback.html">callback</a></span> |
| <span class="signature">→ Function</span> |
| </dt> |
| <dd> |
| The callback to invoke with the option's value when the option is parsed. |
| <div class="features">final</div> |
| </dd> |
| <dt id="defaultsTo" class="property"> |
| <span class="name"><a href="package-args_args/Option/defaultsTo.html">defaultsTo</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| The value this option will have if the user doesn't explicitly pass it in |
| <div class="features">final</div> |
| </dd> |
| <dt id="defaultValue" class="property"> |
| <span class="name"><a class="deprecated" href="package-args_args/Option/defaultValue.html">defaultValue</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| |
| <div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>('Use defaultsTo instead.'), read-only</div> |
| </dd> |
| <dt id="help" class="property"> |
| <span class="name"><a href="package-args_args/Option/help.html">help</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| A description of this option. |
| <div class="features">final</div> |
| </dd> |
| <dt id="hide" class="property"> |
| <span class="name"><a href="package-args_args/Option/hide.html">hide</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether this option should be hidden from usage documentation. |
| <div class="features">final</div> |
| </dd> |
| <dt id="isFlag" class="property"> |
| <span class="name"><a href="package-args_args/Option/isFlag.html">isFlag</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether the option is boolean-valued flag. |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="isMultiple" class="property"> |
| <span class="name"><a href="package-args_args/Option/isMultiple.html">isMultiple</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether the option allows multiple values. |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="isSingle" class="property"> |
| <span class="name"><a href="package-args_args/Option/isSingle.html">isSingle</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether the option takes a single value. |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="name" class="property"> |
| <span class="name"><a href="package-args_args/Option/name.html">name</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| The name of the option that the user passes as an argument. |
| <div class="features">final</div> |
| </dd> |
| <dt id="negatable" class="property"> |
| <span class="name"><a href="package-args_args/Option/negatable.html">negatable</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether this flag's value can be set to <code>false</code>. <a href="package-args_args/Option/negatable.html">[...]</a> |
| <div class="features">final</div> |
| </dd> |
| <dt id="splitCommas" class="property"> |
| <span class="name"><a href="package-args_args/Option/splitCommas.html">splitCommas</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| Whether multiple values may be passed by writing <code>--option a,b</code> in |
| addition to <code>--option a --option b</code>. |
| <div class="features">final</div> |
| </dd> |
| <dt id="type" class="property"> |
| <span class="name"><a href="package-args_args/Option/type.html">type</a></span> |
| <span class="signature">→ <a href="package-args_args/OptionType-class.html">OptionType</a></span> |
| </dt> |
| <dd> |
| Whether this is a flag, a single value option, or a multi-value option. |
| <div class="features">final</div> |
| </dd> |
| <dt id="valueHelp" class="property"> |
| <span class="name"><a href="package-args_args/Option/valueHelp.html">valueHelp</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| A name for the value this option takes. |
| <div class="features">final</div> |
| </dd> |
| <dt id="hashCode" class="property inherited"> |
| <span class="name"><a href="package-args_args/Option/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/Option/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="getOrDefault" class="callable"> |
| <span class="name"><a href="package-args_args/Option/getOrDefault.html">getOrDefault</a></span><span class="signature">(<wbr><span class="parameter" id="getOrDefault-param-value"><span class="type-annotation">dynamic</span> <span class="parameter-name">value</span></span>) |
| <span class="returntype parameter">→ dynamic</span> |
| </span> |
| </dt> |
| <dd> |
| Returns <code>value</code> if non-<code>null</code>, otherwise returns the default value for |
| this option. <a href="package-args_args/Option/getOrDefault.html">[...]</a> |
| |
| </dd> |
| <dt id="noSuchMethod" class="callable inherited"> |
| <span class="name"><a href="package-args_args/Option/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/Option/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/Option/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/Option-class.html#instance-properties">Properties</a> |
| </li> |
| <li><a href="package-args_args/Option/abbr.html">abbr</a></li> |
| <li><a class="deprecated" href="package-args_args/Option/abbreviation.html">abbreviation</a></li> |
| <li><a href="package-args_args/Option/allowed.html">allowed</a></li> |
| <li><a href="package-args_args/Option/allowedHelp.html">allowedHelp</a></li> |
| <li><a href="package-args_args/Option/callback.html">callback</a></li> |
| <li><a href="package-args_args/Option/defaultsTo.html">defaultsTo</a></li> |
| <li><a class="deprecated" href="package-args_args/Option/defaultValue.html">defaultValue</a></li> |
| <li><a href="package-args_args/Option/help.html">help</a></li> |
| <li><a href="package-args_args/Option/hide.html">hide</a></li> |
| <li><a href="package-args_args/Option/isFlag.html">isFlag</a></li> |
| <li><a href="package-args_args/Option/isMultiple.html">isMultiple</a></li> |
| <li><a href="package-args_args/Option/isSingle.html">isSingle</a></li> |
| <li><a href="package-args_args/Option/name.html">name</a></li> |
| <li><a href="package-args_args/Option/negatable.html">negatable</a></li> |
| <li><a href="package-args_args/Option/splitCommas.html">splitCommas</a></li> |
| <li><a href="package-args_args/Option/type.html">type</a></li> |
| <li><a href="package-args_args/Option/valueHelp.html">valueHelp</a></li> |
| <li class="inherited"><a href="package-args_args/Option/hashCode.html">hashCode</a></li> |
| <li class="inherited"><a href="package-args_args/Option/runtimeType.html">runtimeType</a></li> |
| |
| <li class="section-title"><a href="package-args_args/Option-class.html#instance-methods">Methods</a></li> |
| <li><a href="package-args_args/Option/getOrDefault.html">getOrDefault</a></li> |
| <li class="inherited"><a href="package-args_args/Option/noSuchMethod.html">noSuchMethod</a></li> |
| <li class="inherited"><a href="package-args_args/Option/toString.html">toString</a></li> |
| |
| <li class="section-title inherited"><a href="package-args_args/Option-class.html#operators">Operators</a></li> |
| <li class="inherited"><a href="package-args_args/Option/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> |
