blob: f739b6f066f2c5431184161ad3ca6b74c54ceb38 [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 B class from the ex library, for the Dart programming language.">
<title>B class - ex 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="ex/ex-library.html">ex</a></li>
<li class="self-crumb">B class</li>
</ol>
<div class="self-name">B</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">
<header id="header-search-sidebar" class="hidden-l">
<form class="search-sidebar" role="search">
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
<li><a href="index.html">test_package</a></li>
<li><a href="ex/ex-library.html">ex</a></li>
<li class="self-crumb">B class</li>
</ol>
<h5>ex library</h5>
<ol>
<li class="section-title"><a href="ex/ex-library.html#classes">Classes</a></li>
<li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a></li>
<li><a href="ex/Apple-class.html">Apple</a></li>
<li><a href="ex/aThingToDo-class.html">aThingToDo</a></li>
<li><a href="ex/B-class.html">B</a></li>
<li><a href="ex/Cat-class.html">Cat</a></li>
<li><a href="ex/CatString-class.html">CatString</a></li>
<li><a href="ex/ConstantCat-class.html">ConstantCat</a></li>
<li><a href="fake/Cool-class.html">Cool</a></li>
<li><a href="ex/Deprecated-class.html">Deprecated</a></li>
<li><a href="ex/Dog-class.html">Dog</a></li>
<li><a href="ex/E-class.html">E</a></li>
<li><a href="ex/ExtendedShortName-class.html">ExtendedShortName</a></li>
<li><a href="ex/F-class.html">F</a></li>
<li><a href="ex/ForAnnotation-class.html">ForAnnotation</a></li>
<li><a href="ex/HasAnnotation-class.html">HasAnnotation</a></li>
<li><a href="ex/Helper-class.html">Helper</a></li>
<li><a href="ex/HtmlInjection-class.html">HtmlInjection</a></li>
<li><a href="ex/Klass-class.html">Klass</a></li>
<li><a href="ex/ParameterizedClass-class.html">ParameterizedClass</a></li>
<li><a href="ex/PublicClassExtendsPrivateClass-class.html">PublicClassExtendsPrivateClass</a></li>
<li><a href="ex/PublicClassImplementsPrivateInterface-class.html">PublicClassImplementsPrivateInterface</a></li>
<li><a href="ex/ShapeType-class.html">ShapeType</a></li>
<li><a href="ex/ShortName-class.html">ShortName</a></li>
<li><a href="ex/SpecializedDuration-class.html">SpecializedDuration</a></li>
<li><a href="ex/TemplatedClass-class.html">TemplatedClass</a></li>
<li><a href="ex/TemplatedInterface-class.html">TemplatedInterface</a></li>
<li><a href="ex/ToolUser-class.html">ToolUser</a></li>
<li><a href="ex/TypedFunctionsWithoutTypedefs-class.html">TypedFunctionsWithoutTypedefs</a></li>
<li><a href="ex/WithGeneric-class.html">WithGeneric</a></li>
<li><a href="ex/WithGenericSub-class.html">WithGenericSub</a></li>
<li class="section-title"><a href="ex/ex-library.html#constants">Constants</a></li>
<li><a href="ex/COLOR-constant.html">COLOR</a></li>
<li><a href="ex/COLOR_GREEN-constant.html">COLOR_GREEN</a></li>
<li><a href="ex/COLOR_ORANGE-constant.html">COLOR_ORANGE</a></li>
<li><a href="ex/COMPLEX_COLOR-constant.html">COMPLEX_COLOR</a></li>
<li><a href="ex/deprecated-constant.html">deprecated</a></li>
<li><a href="ex/incorrectDocReference-constant.html">incorrectDocReference</a></li>
<li><a href="ex/incorrectDocReferenceFromEx-constant.html">incorrectDocReferenceFromEx</a></li>
<li><a href="ex/MY_CAT-constant.html">MY_CAT</a></li>
<li><a href="ex/PRETTY_COLORS-constant.html">PRETTY_COLORS</a></li>
<li class="section-title"><a href="ex/ex-library.html#properties">Properties</a></li>
<li><a class="deprecated" href="ex/deprecatedField.html">deprecatedField</a></li>
<li><a class="deprecated" href="ex/deprecatedGetter.html">deprecatedGetter</a></li>
<li><a class="deprecated" href="ex/deprecatedSetter.html">deprecatedSetter</a></li>
<li><a href="ex/number.html">number</a></li>
<li><a href="ex/y.html">y</a></li>
<li class="section-title"><a href="ex/ex-library.html#functions">Functions</a></li>
<li><a href="ex/function1.html">function1</a></li>
<li><a href="ex/genericFunction.html">genericFunction</a></li>
<li class="section-title"><a href="ex/ex-library.html#enums">Enums</a></li>
<li><a href="ex/Animal-class.html">Animal</a></li>
<li class="section-title"><a href="ex/ex-library.html#typedefs">Typedefs</a></li>
<li><a href="ex/aComplexTypedef.html">aComplexTypedef</a></li>
<li><a href="ex/ParameterizedTypedef.html">ParameterizedTypedef</a></li>
<li><a href="ex/processMessage.html">processMessage</a></li>
<li class="section-title"><a href="ex/ex-library.html#exceptions">Exceptions</a></li>
<li><a href="ex/MyError-class.html">MyError</a></li>
<li><a href="ex/MyErrorImplements-class.html">MyErrorImplements</a></li>
<li><a href="ex/MyException-class.html">MyException</a></li>
<li><a href="ex/MyExceptionImplements-class.html">MyExceptionImplements</a></li>
</ol>
</div>
<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<h1>B class </h1>
<section class="desc markdown">
<p>Extends class <a href="ex/Apple-class.html">Apple</a>, use <a href="ex/Apple/Apple.html">new Apple</a> or <a href="ex/Apple/Apple.fromString.html">new Apple.fromString</a></p><pre class="language-dart"> B extends A
B implements C
</pre>
</section>
<section>
<dl class="dl-horizontal">
<dt>Inheritance</dt>
<dd><ul class="gt-separated dark clazz-relationships">
<li>Object</li>
<li><a href="ex/Apple-class.html">Apple</a></li>
<li>B</li>
</ul></dd>
<dt>Mixed in types</dt>
<dd><ul class="comma-separated clazz-relationships">
<li><a href="ex/Cat-class.html">Cat</a></li>
</ul></dd>
</dl>
</section>
<section class="summary offset-anchor" id="constructors">
<h2>Constructors</h2>
<dl class="constructor-summary-list">
<dt id="B" class="callable">
<span class="name"><a href="ex/B/B.html">B</a></span><span class="signature">()</span>
</dt>
<dd>
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="instance-properties">
<h2>Properties</h2>
<dl class="properties">
<dt id="autoCompress" class="property">
<span class="name"><a href="ex/B/autoCompress.html">autoCompress</a></span>
<span class="signature">&#8596; bool</span>
</dt>
<dd>
The default value is <code>false</code> (compression disabled).
To enable, set <code>autoCompress</code> to <code>true</code>.
<div class="features">read / write</div>
</dd>
<dt id="isImplemented" class="property">
<span class="name"><a href="ex/B/isImplemented.html">isImplemented</a></span>
<span class="signature">&#8594; bool</span>
</dt>
<dd>
<div class="features">read-only, override</div>
</dd>
<dt id="list" class="property">
<span class="name"><a href="ex/B/list.html">list</a></span>
<span class="signature">&#8596; List<span class="signature">&lt;<wbr><span class="type-parameter">String</span>&gt;</span></span>
</dt>
<dd>
A list of Strings
<div class="features">read / write</div>
</dd>
<dt id="s" class="property">
<span class="name"><a href="ex/B/s.html">s</a></span>
<span class="signature">&#8596; String</span>
</dt>
<dd>
The getter for <code>s</code>
<div class="features">read / write, inherited-setter, override-getter</div>
</dd>
<dt id="fieldWithTypedef" class="property inherited">
<span class="name"><a href="ex/Apple/fieldWithTypedef.html">fieldWithTypedef</a></span>
<span class="signature">&#8594; <a href="ex/ParameterizedTypedef.html">ParameterizedTypedef</a><span class="signature">&lt;<wbr><span class="type-parameter">bool</span>&gt;</span></span>
</dt>
<dd class="inherited">
fieldWithTypedef docs here
<div class="features">final, inherited</div>
</dd>
<dt id="hashCode" class="property inherited">
<span class="name"><a href="ex/Apple/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="m" class="property inherited">
<span class="name"><a href="ex/Apple/m.html">m</a></span>
<span class="signature">&#8596; int</span>
</dt>
<dd class="inherited">
The read-write field <code>m</code>.
<div class="features">read / write, inherited</div>
</dd>
<dt id="runtimeType" class="property inherited">
<span class="name"><a href="ex/Apple/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" id="instance-methods">
<h2>Methods</h2>
<dl class="callables">
<dt id="abstractMethod" class="callable">
<span class="name"><a href="ex/B/abstractMethod.html">abstractMethod</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
<div class="features">override</div>
</dd>
<dt id="doNothing" class="callable">
<span class="name deprecated"><a class="deprecated" href="ex/B/doNothing.html">doNothing</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; Future</span>
</span>
</dt>
<dd>
</dd>
<dt id="m1" class="callable">
<span class="name"><a href="ex/B/m1.html">m1</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
This is a method. <a href="ex/B/m1.html">[...]</a>
<div class="features">override</div>
</dd>
<dt id="writeMsg" class="callable">
<span class="name"><a href="ex/B/writeMsg.html">writeMsg</a></span><span class="signature">(<wbr><span class="parameter" id="writeMsg-param-msg"><span class="type-annotation">String</span> <span class="parameter-name">msg</span>, [</span> <span class="parameter" id="writeMsg-param-transformMsg"><span class="type-annotation">String</span> <span class="parameter-name">transformMsg</span>(<span class="parameter" id="transformMsg-param-origMsg"><span class="type-annotation">String</span> <span class="parameter-name">origMsg</span>, </span> <span class="parameter" id="transformMsg-param-flag"><span class="type-annotation">bool</span> <span class="parameter-name">flag</span></span>)</span> ])
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
</dd>
<dt id="isGreaterThan" class="callable inherited">
<span class="name"><a href="ex/Apple/isGreaterThan.html">isGreaterThan</a></span><span class="signature">(<wbr><span class="parameter" id="isGreaterThan-param-number"><span class="type-annotation">int</span> <span class="parameter-name">number</span>, {</span> <span class="parameter" id="isGreaterThan-param-check"><span class="type-annotation">int</span> <span class="parameter-name">check</span>: <span class="default-value">5</span></span> })
<span class="returntype parameter">&#8594; bool</span>
</span>
</dt>
<dd class="inherited">
<div class="features">inherited</div>
</dd>
<dt id="methodWithTypedefParam" class="callable inherited">
<span class="name"><a href="ex/Apple/methodWithTypedefParam.html">methodWithTypedefParam</a></span><span class="signature">(<wbr><span class="parameter" id="methodWithTypedefParam-param-p"><span class="type-annotation"><a href="ex/processMessage.html">processMessage</a></span> <span class="parameter-name">p</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
<div class="features">inherited</div>
</dd>
<dt id="noSuchMethod" class="callable inherited">
<span class="name"><a href="ex/Apple/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="paramFromExportLib" class="callable inherited">
<span class="name"><a href="ex/Apple/paramFromExportLib.html">paramFromExportLib</a></span><span class="signature">(<wbr><span class="parameter" id="paramFromExportLib-param-helper"><span class="type-annotation"><a href="ex/Helper-class.html">Helper</a></span> <span class="parameter-name">helper</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
<div class="features">inherited</div>
</dd>
<dt id="printMsg" class="callable inherited">
<span class="name"><a href="ex/Apple/printMsg.html">printMsg</a></span><span class="signature">(<wbr><span class="parameter" id="printMsg-param-msg"><span class="type-annotation">String</span> <span class="parameter-name">msg</span>, [</span> <span class="parameter" id="printMsg-param-linebreak"><span class="type-annotation">bool</span> <span class="parameter-name">linebreak</span></span> ])
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
<div class="features">inherited</div>
</dd>
<dt id="toString" class="callable inherited">
<span class="name"><a href="ex/Apple/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>
<dt id="whataclass" class="callable inherited">
<span class="name"><a href="ex/Apple/whataclass.html">whataclass</a></span><span class="signature">(<wbr><span class="parameter" id="whataclass-param-list"><span class="type-annotation">List<span class="signature">&lt;<wbr><span class="type-parameter"><a href="test_package_imported.main/Whataclass-class.html">Whataclass</a><span class="signature">&lt;<wbr><span class="type-parameter">bool</span>&gt;</span></span>&gt;</span></span> <span class="parameter-name">list</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
Apple docs for whataclass
<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="ex/Apple/operator_multiply.html">operator *</a></span><span class="signature">(<wbr><span class="parameter" id="*-param-other"><span class="type-annotation"><a href="ex/Apple-class.html">Apple</a></span> <span class="parameter-name">other</span></span>)
<span class="returntype parameter">&#8594; dynamic</span>
</span>
</dt>
<dd class="inherited">
<div class="features">inherited</div>
</dd>
<dt id="operator ==" class="callable inherited">
<span class="name"><a href="ex/Apple/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>
</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="ex/B-class.html#constructors">Constructors</a></li>
<li><a href="ex/B/B.html">B</a></li>
<li class="section-title">
<a href="ex/B-class.html#instance-properties">Properties</a>
</li>
<li><a href="ex/B/autoCompress.html">autoCompress</a></li>
<li><a href="ex/B/isImplemented.html">isImplemented</a></li>
<li><a href="ex/B/list.html">list</a></li>
<li><a href="ex/B/s.html">s</a></li>
<li class="inherited"><a href="ex/Apple/fieldWithTypedef.html">fieldWithTypedef</a></li>
<li class="inherited"><a href="ex/Apple/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="ex/Apple/m.html">m</a></li>
<li class="inherited"><a href="ex/Apple/runtimeType.html">runtimeType</a></li>
<li class="section-title"><a href="ex/B-class.html#instance-methods">Methods</a></li>
<li><a href="ex/B/abstractMethod.html">abstractMethod</a></li>
<li><a class="deprecated" href="ex/B/doNothing.html">doNothing</a></li>
<li><a href="ex/B/m1.html">m1</a></li>
<li><a href="ex/B/writeMsg.html">writeMsg</a></li>
<li class="inherited"><a href="ex/Apple/isGreaterThan.html">isGreaterThan</a></li>
<li class="inherited"><a href="ex/Apple/methodWithTypedefParam.html">methodWithTypedefParam</a></li>
<li class="inherited"><a href="ex/Apple/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="ex/Apple/paramFromExportLib.html">paramFromExportLib</a></li>
<li class="inherited"><a href="ex/Apple/printMsg.html">printMsg</a></li>
<li class="inherited"><a href="ex/Apple/toString.html">toString</a></li>
<li class="inherited"><a href="ex/Apple/whataclass.html">whataclass</a></li>
<li class="section-title inherited"><a href="ex/B-class.html#operators">Operators</a></li>
<li class="inherited"><a href="ex/Apple/operator_multiply.html">operator *</a></li>
<li class="inherited"><a href="ex/Apple/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>