blob: febb2842253f9fa87d6884f274406acc62a63bc3 [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 sort method from the SpecialList class, for the Dart programming language.">
<title>sort method - SpecialList class - fake library - Dart API</title>
<!-- required because all the links are pseudo-absolute -->
<base href="../..">
<link rel='stylesheet' href='https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400' type='text/css'>
<link rel="stylesheet" href="static-assets/prettify.css">
<link rel="stylesheet" href="static-assets/css/bootstrap.min.css">
<link rel="stylesheet" href="static-assets/styles.css">
<link rel="icon" href="static-assets/favicon.png">
<!-- Do not remove placeholder -->
<!-- Header Placeholder -->
</head>
<body>
<div id="overlay-under-drawer"></div>
<header class="container-fluid" id="title">
<nav class="navbar navbar-fixed-top">
<div class="container">
<div class="row">
<div class="col-sm-12 contents">
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated hidden-xs">
<li><a href="index.html">test_package</a></li>
<li><a href="fake/fake-library.html">fake</a></li>
<li><a href="fake/SpecialList-class.html">SpecialList</a></li>
<li class="self-crumb">sort</li>
</ol>
<div class="self-name">sort</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>
</div> <!-- /col -->
</div> <!-- /row -->
</div> <!-- /container -->
</nav>
<div class="container masthead">
<div class="row">
<div class="col-sm-12 contents">
<ol class="breadcrumbs gt-separated visible-xs">
<li><a href="index.html">test_package</a></li>
<li><a href="fake/fake-library.html">fake</a></li>
<li><a href="fake/SpecialList-class.html">SpecialList</a></li>
<li class="self-crumb">sort</li>
</ol>
<div class="title-description">
<h1 class="title">
<span class="kind">method</span> sort
</h1>
</div>
</div> <!-- /col -->
</div> <!-- /row -->
</div> <!-- /container -->
</header>
<div class="container body">
<div class="row">
<div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
<h5><a href="index.html">test_package</a></h5>
<h5><a href="fake/fake-library.html">fake</a></h5>
<h5><a href="fake/SpecialList-class.html">SpecialList</a></h5>
<ol>
<li class="section-title"><a href="fake/SpecialList-class.html#constructors">Constructors</a></li>
<li><a href="fake/SpecialList/SpecialList.html">SpecialList</a></li>
<li class="section-title">
<a href="fake/SpecialList-class.html#instance-properties">Properties</a>
</li>
<li><a href="fake/SpecialList/length.html">length</a></li>
<li class="inherited"><a href="fake/SpecialList/first.html">first</a></li>
<li class="inherited"><a href="fake/SpecialList/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="fake/SpecialList/isEmpty.html">isEmpty</a></li>
<li class="inherited"><a href="fake/SpecialList/isNotEmpty.html">isNotEmpty</a></li>
<li class="inherited"><a href="fake/SpecialList/iterator.html">iterator</a></li>
<li class="inherited"><a href="fake/SpecialList/last.html">last</a></li>
<li class="inherited"><a href="fake/SpecialList/reversed.html">reversed</a></li>
<li class="inherited"><a href="fake/SpecialList/runtimeType.html">runtimeType</a></li>
<li class="inherited"><a href="fake/SpecialList/single.html">single</a></li>
<li class="section-title inherited"><a href="fake/SpecialList-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="fake/SpecialList/add.html">add</a></li>
<li class="inherited"><a href="fake/SpecialList/addAll.html">addAll</a></li>
<li class="inherited"><a href="fake/SpecialList/any.html">any</a></li>
<li class="inherited"><a href="fake/SpecialList/asMap.html">asMap</a></li>
<li class="inherited"><a href="fake/SpecialList/clear.html">clear</a></li>
<li class="inherited"><a href="fake/SpecialList/contains.html">contains</a></li>
<li class="inherited"><a href="fake/SpecialList/elementAt.html">elementAt</a></li>
<li class="inherited"><a href="fake/SpecialList/every.html">every</a></li>
<li class="inherited"><a href="fake/SpecialList/expand.html">expand</a></li>
<li class="inherited"><a href="fake/SpecialList/fillRange.html">fillRange</a></li>
<li class="inherited"><a href="fake/SpecialList/firstWhere.html">firstWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/fold.html">fold</a></li>
<li class="inherited"><a href="fake/SpecialList/forEach.html">forEach</a></li>
<li class="inherited"><a href="fake/SpecialList/getRange.html">getRange</a></li>
<li class="inherited"><a href="fake/SpecialList/indexOf.html">indexOf</a></li>
<li class="inherited"><a href="fake/SpecialList/insert.html">insert</a></li>
<li class="inherited"><a href="fake/SpecialList/insertAll.html">insertAll</a></li>
<li class="inherited"><a href="fake/SpecialList/join.html">join</a></li>
<li class="inherited"><a href="fake/SpecialList/lastIndexOf.html">lastIndexOf</a></li>
<li class="inherited"><a href="fake/SpecialList/lastWhere.html">lastWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/map.html">map</a></li>
<li class="inherited"><a href="fake/SpecialList/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="fake/SpecialList/reduce.html">reduce</a></li>
<li class="inherited"><a href="fake/SpecialList/remove.html">remove</a></li>
<li class="inherited"><a href="fake/SpecialList/removeAt.html">removeAt</a></li>
<li class="inherited"><a href="fake/SpecialList/removeLast.html">removeLast</a></li>
<li class="inherited"><a href="fake/SpecialList/removeRange.html">removeRange</a></li>
<li class="inherited"><a href="fake/SpecialList/removeWhere.html">removeWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/replaceRange.html">replaceRange</a></li>
<li class="inherited"><a href="fake/SpecialList/retainWhere.html">retainWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/setAll.html">setAll</a></li>
<li class="inherited"><a href="fake/SpecialList/setRange.html">setRange</a></li>
<li class="inherited"><a href="fake/SpecialList/shuffle.html">shuffle</a></li>
<li class="inherited"><a href="fake/SpecialList/singleWhere.html">singleWhere</a></li>
<li class="inherited"><a href="fake/SpecialList/skip.html">skip</a></li>
<li class="inherited"><a href="fake/SpecialList/skipWhile.html">skipWhile</a></li>
<li class="inherited"><a href="fake/SpecialList/sort.html">sort</a></li>
<li class="inherited"><a href="fake/SpecialList/sublist.html">sublist</a></li>
<li class="inherited"><a href="fake/SpecialList/take.html">take</a></li>
<li class="inherited"><a href="fake/SpecialList/takeWhile.html">takeWhile</a></li>
<li class="inherited"><a href="fake/SpecialList/toList.html">toList</a></li>
<li class="inherited"><a href="fake/SpecialList/toSet.html">toSet</a></li>
<li class="inherited"><a href="fake/SpecialList/toString.html">toString</a></li>
<li class="inherited"><a href="fake/SpecialList/where.html">where</a></li>
<li class="section-title"><a href="fake/SpecialList-class.html#operators">Operators</a></li>
<li><a href="fake/SpecialList/operator_get.html">operator []</a></li>
<li><a href="fake/SpecialList/operator_put.html">operator []=</a></li>
<li class="inherited"><a href="fake/SpecialList/operator_equals.html">operator ==</a></li>
</ol>
</div><!--/.sidebar-offcanvas-->
<div class="col-xs-12 col-sm-9 col-md-8 main-content">
<section class="multi-line-signature">
<span class="returntype">void</span>
<span class="name ">sort</span>(<wbr>[<span class="parameter" id="sort-param-compare"><span class="type-annotation">int</span> <span class="parameter-name">compare</span>(<span class="parameter" id="compare-param-a"><span class="type-annotation">E</span> <span class="parameter-name">a</span>, </span> <span class="parameter" id="compare-param-b"><span class="type-annotation">E</span> <span class="parameter-name">b</span></span>)</span> ])
</section>
<section class="desc markdown">
<p>Sorts this list according to the order specified by the <code>compare</code> function.</p>
<p>The <code>compare</code> function must act as a <code>Comparator</code>.</p>
<pre class="prettyprint language-dart"><code>List&lt;String&gt; numbers = ['two', 'three', 'four'];
// Sort from shortest to longest.
numbers.sort((a, b) =&gt; a.length.compareTo(b.length));
print(numbers); // [two, four, three]
</code></pre>
<p>The default List implementations use <code>Comparable.compare</code> if
<code>compare</code> is omitted.</p>
<pre class="prettyprint language-dart"><code>List&lt;int&gt; nums = [13, 2, -11];
nums.sort();
print(nums); // [-11, 2, 13]
</code></pre>
<p>A <code>Comparator</code> may compare objects as equal (return zero), even if they
are distinct objects.
The sort function is not guaranteed to be stable, so distinct objects
that compare as equal may occur in any order in the result:</p>
<pre class="prettyprint language-dart"><code>List&lt;String&gt; numbers = ['one', 'two', 'three', 'four'];
numbers.sort((a, b) =&gt; a.length.compareTo(b.length));
print(numbers); // [one, two, four, three] OR [two, one, four, three]
</code></pre>
</section>
</div> <!-- /.main-content -->
</div> <!-- row -->
</div> <!-- container -->
<footer>
<div class="container-fluid">
<div class="container">
<p class="text-center">
<span class="no-break">
test_package 0.0.1
</span>
&bull;
<span class="no-break">
<a href="https://www.dartlang.org">
<img src="static-assets/favicon.png" alt="Dart" title="Dart" width="16" height="16">
</a>
</span>
&bull;
<span class="copyright no-break">
<a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
</span>
</p>
</div>
</div>
</footer>
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
<script src="static-assets/typeahead.bundle.min.js"></script>
<script src="static-assets/prettify.js"></script>
<script src="static-assets/URI.js"></script>
<script src="static-assets/script.js"></script>
<!-- Do not remove placeholder -->
<!-- Footer Placeholder -->
</body>
</html>