diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/qe/QueryHints.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/qe/QueryHints.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/qe/QueryHints.html | 387 |
1 files changed, 387 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/qe/QueryHints.html b/apidocs/com/amazon/carbonado/qe/QueryHints.html new file mode 100644 index 0000000..6e631c7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHints.html @@ -0,0 +1,387 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>QueryHints (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="QueryHints (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/QueryHints.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/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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.amazon.carbonado.qe</div> +<h2 title="Class QueryHints" class="title">Class QueryHints</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryHints</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryHints</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">An immutable map of query hints.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><code>QueryHint</code></a>, +<a href="../../../../serialized-form.html#com.amazon.carbonado.qe.QueryHints">Serialized Form</a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#contains(com.amazon.carbonado.qe.QueryHint)">contains</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns false if hint is not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#emptyHints()">emptyHints</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns null if hint is not provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.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/amazon/carbonado/qe/QueryHints.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</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.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="emptyHints()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emptyHints</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> emptyHints()</pre> +</li> +</ul> +<a name="with(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> with(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns a new QueryHints object with the given hint. The associated + value is the hint object itself.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if hint is null</dd></dl> +</li> +</ul> +<a name="with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> with(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</pre> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if hint or value is null</dd></dl> +</li> +</ul> +<a name="without(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>without</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> without(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</li> +</ul> +<a name="contains(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns false if hint is not provided.</div> +</li> +</ul> +<a name="get(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.Object get(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns null if hint is not provided.</div> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +</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>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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="../../../../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/QueryHints.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/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |