Google Git
Sign in
dart / dartdoc / 3494543257db290f5b541770934decbc85e88643 / . / testing / test_package_docs / package-args_args / OptionType-class.html
blob: 1c4f71a0de51310e252730d03568097617a11c03 [file] [log] [blame]
<!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 OptionType class from the args library, for the Dart programming language.">
<title>OptionType 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">&nbsp;</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">OptionType class</li>
</ol>
<div class="self-name">OptionType</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>OptionType class </h1>
<section class="desc markdown">
<p>What kinds of values an option accepts.</p>
</section>
<section class="summary offset-anchor" id="instance-properties">
<h2>Properties</h2>
<dl class="properties">
<dt id="name" class="property">
<span class="name"><a href="package-args_args/OptionType/name.html">name</a></span>
<span class="signature">&#8594; String</span>
</dt>
<dd>
<div class="features">final</div>
</dd>
<dt id="hashCode" class="property inherited">
<span class="name"><a href="package-args_args/OptionType/hashCode.html">hashCode</a></span>
<span class="signature">&#8594; 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/OptionType/runtimeType.html">runtimeType</a></span>
<span class="signature">&#8594; Type</span>
</dt>
<dd class="inherited">
<div class="features">read-only, inherited</div>
</dd>
</dl>
</section>
<section class="summary offset-anchor inherited" id="instance-methods">
<h2>Methods</h2>
<dl class="callables">
<dt id="noSuchMethod" class="callable inherited">
<span class="name"><a href="package-args_args/OptionType/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">&#8594; 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/OptionType/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; 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/OptionType/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">&#8594; bool</span>
</span>
</dt>
<dd class="inherited">
<div class="features">inherited</div>
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="constants">
<h2>Constants</h2>
<dl class="properties">
<dt id="FLAG" class="constant">
<span class="name deprecated"><a class="deprecated" href="package-args_args/OptionType/FLAG-constant.html">FLAG</a></span>
<span class="signature">&#8594; const <a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
<div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>(&quot;Use OptionType.flag instead.&quot;)</div>
<div>
<span class="signature"><code>flag</code></span>
</div>
</dd>
<dt id="flag" class="constant">
<span class="name "><a href="package-args_args/OptionType/flag-constant.html">flag</a></span>
<span class="signature">&#8594; const <a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
An option that can only be <code>true</code> or <code>false</code>. <a href="package-args_args/OptionType/flag-constant.html">[...]</a>
<div>
<span class="signature"><code>const OptionType._(&quot;OptionType.flag&quot;)</code></span>
</div>
</dd>
<dt id="MULTIPLE" class="constant">
<span class="name deprecated"><a class="deprecated" href="package-args_args/OptionType/MULTIPLE-constant.html">MULTIPLE</a></span>
<span class="signature">&#8594; const <a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
<div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>(&quot;Use OptionType.multiple instead.&quot;)</div>
<div>
<span class="signature"><code>multiple</code></span>
</div>
</dd>
<dt id="multiple" class="constant">
<span class="name "><a href="package-args_args/OptionType/multiple-constant.html">multiple</a></span>
<span class="signature">&#8594; const <a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
An option that allows multiple values. <a href="package-args_args/OptionType/multiple-constant.html">[...]</a>
<div>
<span class="signature"><code>const OptionType._(&quot;OptionType.multiple&quot;)</code></span>
</div>
</dd>
<dt id="SINGLE" class="constant">
<span class="name deprecated"><a class="deprecated" href="package-args_args/OptionType/SINGLE-constant.html">SINGLE</a></span>
<span class="signature">&#8594; const <a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
<div class="features">@<a href="ex/Deprecated-class.html">Deprecated</a>(&quot;Use OptionType.single instead.&quot;)</div>
<div>
<span class="signature"><code>single</code></span>
</div>
</dd>
<dt id="single" class="constant">
<span class="name "><a href="package-args_args/OptionType/single-constant.html">single</a></span>
<span class="signature">&#8594; const <a href="package-args_args/OptionType-class.html">OptionType</a></span>
</dt>
<dd>
An option that takes a single value. <a href="package-args_args/OptionType/single-constant.html">[...]</a>
<div>
<span class="signature"><code>const OptionType._(&quot;OptionType.single&quot;)</code></span>
</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/OptionType-class.html#instance-properties">Properties</a>
</li>
<li><a href="package-args_args/OptionType/name.html">name</a></li>
<li class="inherited"><a href="package-args_args/OptionType/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="package-args_args/OptionType/runtimeType.html">runtimeType</a></li>
<li class="section-title inherited"><a href="package-args_args/OptionType-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="package-args_args/OptionType/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="package-args_args/OptionType/toString.html">toString</a></li>
<li class="section-title inherited"><a href="package-args_args/OptionType-class.html#operators">Operators</a></li>
<li class="inherited"><a href="package-args_args/OptionType/operator_equals.html">operator ==</a></li>
<li class="section-title"><a href="package-args_args/OptionType-class.html#constants">Constants</a></li>
<li><a class="deprecated" href="package-args_args/OptionType/FLAG-constant.html">FLAG</a></li>
<li><a href="package-args_args/OptionType/flag-constant.html">flag</a></li>
<li><a class="deprecated" href="package-args_args/OptionType/MULTIPLE-constant.html">MULTIPLE</a></li>
<li><a href="package-args_args/OptionType/multiple-constant.html">multiple</a></li>
<li><a class="deprecated" href="package-args_args/OptionType/SINGLE-constant.html">SINGLE</a></li>
<li><a href="package-args_args/OptionType/single-constant.html">single</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>