summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/info/Direction.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/info/Direction.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/info/Direction.html')
-rw-r--r--apidocs/com/amazon/carbonado/info/Direction.html388
1 files changed, 388 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/info/Direction.html b/apidocs/com/amazon/carbonado/info/Direction.html
new file mode 100644
index 0000000..b1e7db0
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/info/Direction.html
@@ -0,0 +1,388 @@
+<!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_25) on Tue Dec 03 13:53:43 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>Direction (Carbonado 1.2.3 API)</title>
+<meta name="date" content="2013-12-03">
+<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="Direction (Carbonado 1.2.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="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/Direction.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-files/index-1.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/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/info/Direction.html" target="_top">Frames</a></li>
+<li><a href="Direction.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</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.amazon.carbonado.info</div>
+<h2 title="Enum Direction" class="title">Enum Direction</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.Enum&lt;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&gt;</li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.info.Direction</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&gt;</dd>
+</dl>
+<hr>
+<br>
+<pre>public enum <span class="strong">Direction</span>
+extends java.lang.Enum&lt;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&gt;</pre>
+<div class="block">Describes a property sorting direction.</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill</dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ENUM CONSTANT SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum_constant_summary">
+<!-- -->
+</a>
+<h3>Enum Constant Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
+<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Enum Constant and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#ASCENDING">ASCENDING</a></strong></code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#DESCENDING">DESCENDING</a></strong></code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#UNSPECIFIED">UNSPECIFIED</a></strong></code>&nbsp;</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== 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">&nbsp;</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>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#fromCharacter(char)">fromCharacter</a></strong>(char&nbsp;c)</code>
+<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything
+ else.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#reverse()">reverse</a></strong>()</code>
+<div class="block">Returns the reverse direction of this.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>char</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#toCharacter()">toCharacter</a></strong>()</code>
+<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String&nbsp;name)</code>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#values()">values</a></strong>()</code>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
+<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
+<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ENUM CONSTANT DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum_constant_detail">
+<!-- -->
+</a>
+<h3>Enum Constant Detail</h3>
+<a name="ASCENDING">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ASCENDING</h4>
+<pre>public static final&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> ASCENDING</pre>
+</li>
+</ul>
+<a name="DESCENDING">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DESCENDING</h4>
+<pre>public static final&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> DESCENDING</pre>
+</li>
+</ul>
+<a name="UNSPECIFIED">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>UNSPECIFIED</h4>
+<pre>public static final&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> UNSPECIFIED</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="values()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>values</h4>
+<pre>public static&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]&nbsp;values()</pre>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+<pre>
+for (Direction c : Direction.values())
+&nbsp; System.out.println(c);
+</pre></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
+the order they are declared</dd></dl>
+</li>
+</ul>
+<a name="valueOf(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>valueOf</h4>
+<pre>public static&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
+<div class="block">Returns the enum constant of this type with the specified name.
+The string must match <i>exactly</i> an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
+with the specified name</dd>
+<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
+</li>
+</ul>
+<a name="reverse()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reverse</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;reverse()</pre>
+<div class="block">Returns the reverse direction of this.</div>
+</li>
+</ul>
+<a name="toCharacter()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toCharacter</h4>
+<pre>public&nbsp;char&nbsp;toCharacter()</pre>
+<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div>
+</li>
+</ul>
+<a name="fromCharacter(char)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>fromCharacter</h4>
+<pre>public static&nbsp;<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>&nbsp;fromCharacter(char&nbsp;c)</pre>
+<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything
+ else.</div>
+</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="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/Direction.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-files/index-1.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/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/info/Direction.html" target="_top">Frames</a></li>
+<li><a href="Direction.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>