cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>Term.Terminal (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/Term.Terminal.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="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/Tuples.html" title="class in org.apache.cassandra.cql3"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cql3/Term.Terminal.html" target="_top">Frames</a></li> <li><a href="Term.Terminal.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.cql3</div> <h2 title="Class Term.Terminal" class="title">Class Term.Terminal</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.Term.Terminal</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/cql3/Constants.Value.html" title="class in org.apache.cassandra.cql3">Constants.Value</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.Value.html" title="class in org.apache.cassandra.cql3">Maps.Value</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.Value.html" title="class in org.apache.cassandra.cql3">Sets.Value</a>, <a href="../../../../org/apache/cassandra/cql3/Term.MultiItemTerminal.html" title="class in org.apache.cassandra.cql3">Term.MultiItemTerminal</a>, <a href="../../../../org/apache/cassandra/cql3/Tuples.InValue.html" title="class in org.apache.cassandra.cql3">Tuples.InValue</a></dd> </dl> <dl> <dt>Enclosing interface:</dt> <dd><a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></dd> </dl> <hr> <br> <pre>public abstract static class <span class="strong">Term.Terminal</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></pre> <div class="block">A terminal term, one that can be reduced to a byte buffer directly. This includes most terms that don't have a bind marker (an exception being delayed call for non pure function that are NonTerminal even if they don't have bind markers). This can be only one of: - a constant value - a collection value Note that a terminal term will always have been type checked, and thus consumer can (and should) assume so.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested_class_summary">  </a> <h3>Nested Class Summary</h3> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.cql3.Term">  </a> <h3>Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.<a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></h3> <code><a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a>, <a href="../../../../org/apache/cassandra/cql3/Term.MultiItemTerminal.html" title="class in org.apache.cassandra.cql3">Term.MultiItemTerminal</a>, <a href="../../../../org/apache/cassandra/cql3/Term.NonTerminal.html" title="class in org.apache.cassandra.cql3">Term.NonTerminal</a>, <a href="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3">Term.Raw</a>, <a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a></code></li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_summary">  </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html#Term.Terminal()">Term.Terminal</a></strong>()</code> </td> </tr> </table> </li> </ul>  <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><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html#bind(org.apache.cassandra.cql3.QueryOptions)">bind</a></strong>(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code> <div class="block">Bind the values in this term to the values contained in <code>values</code>.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html#bindAndGet(org.apache.cassandra.cql3.QueryOptions)">bindAndGet</a></strong>(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code> <div class="block">A shorter for bind(values).get().</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html#collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">collectMarkerSpecification</a></strong>(<a href="../../../../org/apache/cassandra/cql3/VariableSpecifications.html" title="class in org.apache.cassandra.cql3">VariableSpecifications</a> boundNames)</code> <div class="block">Collects the column specification for the bind variables in this Term.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html#containsBindMarker()">containsBindMarker</a></strong>()</code> <div class="block">Whether or not that term contains at least one bind marker.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html#get(org.apache.cassandra.cql3.QueryOptions)">get</a></strong>(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</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.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="Term.Terminal()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>Term.Terminal</h4> <pre>public Term.Terminal()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">  </a> <ul class="blockList"> <li class="blockList"> <h4>collectMarkerSpecification</h4> <pre>public void collectMarkerSpecification(<a href="../../../../org/apache/cassandra/cql3/VariableSpecifications.html" title="class in org.apache.cassandra.cql3">VariableSpecifications</a> boundNames)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/cql3/Term.html#collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">Term</a></code></strong></div> <div class="block">Collects the column specification for the bind variables in this Term. This is obviously a no-op if the term is Terminal.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cql3/Term.html#collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">collectMarkerSpecification</a></code> in interface <code><a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>boundNames</code> - the variables specification where to collect the bind variables of this term in.</dd></dl> </li> </ul> <a name="bind(org.apache.cassandra.cql3.QueryOptions)">  </a> <ul class="blockList"> <li class="blockList"> <h4>bind</h4> <pre>public <a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a> bind(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/cql3/Term.html#bind(org.apache.cassandra.cql3.QueryOptions)">Term</a></code></strong></div> <div class="block">Bind the values in this term to the values contained in <code>values</code>. This is obviously a no-op if the term is Terminal.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cql3/Term.html#bind(org.apache.cassandra.cql3.QueryOptions)">bind</a></code> in interface <code><a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - the values to bind markers to.</dd> <dt><span class="strong">Returns:</span></dt><dd>the result of binding all the variables of this NonTerminal (or 'this' if the term is terminal).</dd></dl> </li> </ul> <a name="containsBindMarker()">  </a> <ul class="blockList"> <li class="blockList"> <h4>containsBindMarker</h4> <pre>public boolean containsBindMarker()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/cql3/Term.html#containsBindMarker()">Term</a></code></strong></div> <div class="block">Whether or not that term contains at least one bind marker. Note that this is slightly different from being or not a NonTerminal, because calls to non pure functions will be NonTerminal (see #5616) even if they don't have bind markers.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cql3/Term.html#containsBindMarker()">containsBindMarker</a></code> in interface <code><a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></code></dd> </dl> </li> </ul> <a name="get(org.apache.cassandra.cql3.QueryOptions)">  </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> <pre>public abstract java.nio.ByteBuffer get(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the serialized value of this terminal.</dd></dl> </li> </ul> <a name="bindAndGet(org.apache.cassandra.cql3.QueryOptions)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>bindAndGet</h4> <pre>public java.nio.ByteBuffer bindAndGet(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options) throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/cql3/Term.html#bindAndGet(org.apache.cassandra.cql3.QueryOptions)">Term</a></code></strong></div> <div class="block">A shorter for bind(values).get(). We expose it mainly because for constants it can avoids allocating a temporary object between the bind and the get (note that we still want to be able to separate bind and get for collections).</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cql3/Term.html#bindAndGet(org.apache.cassandra.cql3.QueryOptions)">bindAndGet</a></code> in interface <code><a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></code></dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/Term.Terminal.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="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/Tuples.html" title="class in org.apache.cassandra.cql3"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cql3/Term.Terminal.html" target="_top">Frames</a></li> <li><a href="Term.Terminal.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>