diff options
Diffstat (limited to '1.3/sangria-core/apidocs/com/tavianator/sangria/core/Priority.html')
-rw-r--r-- | 1.3/sangria-core/apidocs/com/tavianator/sangria/core/Priority.html | 371 |
1 files changed, 371 insertions, 0 deletions
diff --git a/1.3/sangria-core/apidocs/com/tavianator/sangria/core/Priority.html b/1.3/sangria-core/apidocs/com/tavianator/sangria/core/Priority.html new file mode 100644 index 0000000..315972c --- /dev/null +++ b/1.3/sangria-core/apidocs/com/tavianator/sangria/core/Priority.html @@ -0,0 +1,371 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Fri May 08 20:52:18 EDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Priority (Sangria Core 1.3 API)</title> +<meta name="date" content="2015-05-08"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Priority (Sangria Core 1.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../com/tavianator/sangria/core/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Priority.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/tavianator/sangria/core/PrettyTypes.html" title="class in com.tavianator.sangria.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/tavianator/sangria/core/TypeLiterals.html" title="class in com.tavianator.sangria.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/tavianator/sangria/core/Priority.html" target="_top">Frames</a></li> +<li><a href="Priority.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.tavianator.sangria.core</div> +<h2 title="Class Priority" class="title">Class Priority</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>com.tavianator.sangria.core.Priority</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Priority</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a>></pre> +<div class="block">A loosely-coupled, infinitely divisible priority/weight system. + + <p> + This class implements an extensible priority system based on lexicographical ordering. In its simplest use, <code>Priority.create(0)</code> is ordered before <code>Priority.create(1)</code>, then <code>Priority.create(2)</code>, etc. + </p> + + <p> + To create a priority that is ordered between two existing ones, simply add another parameter: <code>Priority.create(1, 1)</code> comes after <code>Priority.create(1)</code>, but before <code>Priority.create(2)</code>. In this way, + priorities can always be inserted anywhere in a sequence. + </p> + + <p> + The <a href="../../../../com/tavianator/sangria/core/Priority.html#next()"><code>next()</code></a> method creates a priority that is ordered immediately following the current one, and is distinct + from all priorities obtained by any other means. This provides a convenient way to order entire segments of lists. + </p> + + <p> + A special priority, obtained by <code>Priority.getDefault()</code>, sorts before all other priorities. + </p></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.1</dd> +<dt><span class="strong">Version:</span></dt> + <dd>1.1</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Tavian Barnes (tavianator@tavianator.com)</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#compareTo(com.tavianator.sangria.core.Priority)">compareTo</a></strong>(<a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a> o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#create(int,%20int...)">create</a></strong>(int weight, + int... weights)</code> +<div class="block">Create a <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core"><code>Priority</code></a> with the given sequence.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#getDefault()">getDefault</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#isDefault()">isDefault</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/tavianator/sangria/core/Priority.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefault</h4> +<pre>public static <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a> getDefault()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The default priority, which comes before all other priorities.</dd></dl> +</li> +</ul> +<a name="create(int, int...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a> create(int weight, + int... weights)</pre> +<div class="block">Create a <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core"><code>Priority</code></a> with the given sequence.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>weight</code> - The first value of the weight sequence.</dd><dd><code>weights</code> - An integer sequence. These sequences are sorted lexicographically, so <code>Priority.create(1)</code> + sorts before <code>Priority.create(1, 1)</code>, which sorts before <code>Priority.create(2)</code>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A new <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core"><code>Priority</code></a>.</dd></dl> +</li> +</ul> +<a name="isDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDefault</h4> +<pre>public boolean isDefault()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Whether this priority originated in a call to <a href="../../../../com/tavianator/sangria/core/Priority.html#getDefault()"><code>getDefault()</code></a>.</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a> next()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>A new <a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core"><code>Priority</code></a> which immediately follows this one, and which is distinct from all other + priorities obtained by <a href="../../../../com/tavianator/sangria/core/Priority.html#create(int,%20int...)"><code>create(int, int...)</code></a>.</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="compareTo(com.tavianator.sangria.core.Priority)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a> o)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/tavianator/sangria/core/Priority.html" title="class in com.tavianator.sangria.core">Priority</a>></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../com/tavianator/sangria/core/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Priority.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/tavianator/sangria/core/PrettyTypes.html" title="class in com.tavianator.sangria.core"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/tavianator/sangria/core/TypeLiterals.html" title="class in com.tavianator.sangria.core"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/tavianator/sangria/core/Priority.html" target="_top">Frames</a></li> +<li><a href="Priority.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014–2015. All rights reserved.</small></p> +</body> +</html> |