UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

514 lines (512 loc) 20.5 kB
<!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_67) on Sun Sep 07 15:29:32 CEST 2014 --> <title>CounterContext.ContextState (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"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="CounterContext.ContextState (apache-cassandra 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/CounterContext.ContextState.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/db/context/CounterContext.html" title="class in org.apache.cassandra.db.context"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/context/CounterContext.Relationship.html" title="enum in org.apache.cassandra.db.context"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/context/CounterContext.ContextState.html" target="_top">Frames</a></li> <li><a href="CounterContext.ContextState.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="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li>Constr&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">org.apache.cassandra.db.context</div> <h2 title="Class CounterContext.ContextState" class="title">Class CounterContext.ContextState</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.context.CounterContext.ContextState</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../../../org/apache/cassandra/db/context/CounterContext.html" title="class in org.apache.cassandra.db.context">CounterContext</a></dd> </dl> <hr> <br> <pre>public static class <span class="strong">CounterContext.ContextState</span> extends java.lang.Object</pre> <div class="block">Helper class to work on contexts (works by iterating over them). A context being abstractly a list of tuple (counterid, clock, count), a ContextState encapsulate a context and a position to one of the tuple. It also allow to create new context iteratively. Note: this is intrinsically a private class intended for use by the methods of CounterContext only. It is however public because it is convenient to create handcrafted context for unit tests.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#context">context</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#headerLength">headerLength</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="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#allocate(int,%20int,%20int)">allocate</a></strong>(int&nbsp;globalCount, int&nbsp;localCount, int&nbsp;remoteCount)</code> <div class="block">Allocate a new context big enough for globalCount + localCount + remoteCount elements and return the initial corresponding ContextState.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#compareIdTo(org.apache.cassandra.db.context.CounterContext.ContextState)">compareIdTo</a></strong>(<a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a>&nbsp;other)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#copyTo(org.apache.cassandra.db.context.CounterContext.ContextState)">copyTo</a></strong>(<a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a>&nbsp;other)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#getClock()">getClock</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#getCount()">getCount</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#getCounterId()">getCounterId</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#getElementIndex()">getElementIndex</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#hasRemaining()">hasRemaining</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#isGlobal()">isGlobal</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#isLocal()">isLocal</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#isRemote()">isRemote</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#moveToNext()">moveToNext</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#reset()">reset</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#wrap(java.nio.ByteBuffer)">wrap</a></strong>(java.nio.ByteBuffer&nbsp;context)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#writeGlobal(org.apache.cassandra.utils.CounterId,%20long,%20long)">writeGlobal</a></strong>(<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;id, long&nbsp;clock, long&nbsp;count)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#writeLocal(org.apache.cassandra.utils.CounterId,%20long,%20long)">writeLocal</a></strong>(<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;id, long&nbsp;clock, long&nbsp;count)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html#writeRemote(org.apache.cassandra.utils.CounterId,%20long,%20long)">writeRemote</a></strong>(<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;id, long&nbsp;clock, long&nbsp;count)</code>&nbsp;</td> </tr> </table> <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>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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="context"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>context</h4> <pre>public final&nbsp;java.nio.ByteBuffer context</pre> </li> </ul> <a name="headerLength"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>headerLength</h4> <pre>public final&nbsp;int headerLength</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="wrap(java.nio.ByteBuffer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>wrap</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a>&nbsp;wrap(java.nio.ByteBuffer&nbsp;context)</pre> </li> </ul> <a name="allocate(int, int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>allocate</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a>&nbsp;allocate(int&nbsp;globalCount, int&nbsp;localCount, int&nbsp;remoteCount)</pre> <div class="block">Allocate a new context big enough for globalCount + localCount + remoteCount elements and return the initial corresponding ContextState.</div> </li> </ul> <a name="isGlobal()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isGlobal</h4> <pre>public&nbsp;boolean&nbsp;isGlobal()</pre> </li> </ul> <a name="isLocal()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isLocal</h4> <pre>public&nbsp;boolean&nbsp;isLocal()</pre> </li> </ul> <a name="isRemote()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isRemote</h4> <pre>public&nbsp;boolean&nbsp;isRemote()</pre> </li> </ul> <a name="hasRemaining()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasRemaining</h4> <pre>public&nbsp;boolean&nbsp;hasRemaining()</pre> </li> </ul> <a name="moveToNext()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>moveToNext</h4> <pre>public&nbsp;void&nbsp;moveToNext()</pre> </li> </ul> <a name="copyTo(org.apache.cassandra.db.context.CounterContext.ContextState)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>copyTo</h4> <pre>public&nbsp;void&nbsp;copyTo(<a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a>&nbsp;other)</pre> </li> </ul> <a name="compareIdTo(org.apache.cassandra.db.context.CounterContext.ContextState)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>compareIdTo</h4> <pre>public&nbsp;int&nbsp;compareIdTo(<a href="../../../../../org/apache/cassandra/db/context/CounterContext.ContextState.html" title="class in org.apache.cassandra.db.context">CounterContext.ContextState</a>&nbsp;other)</pre> </li> </ul> <a name="reset()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>reset</h4> <pre>public&nbsp;void&nbsp;reset()</pre> </li> </ul> <a name="getElementIndex()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getElementIndex</h4> <pre>public&nbsp;int&nbsp;getElementIndex()</pre> </li> </ul> <a name="getCounterId()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCounterId</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;getCounterId()</pre> </li> </ul> <a name="getClock()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClock</h4> <pre>public&nbsp;long&nbsp;getClock()</pre> </li> </ul> <a name="getCount()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCount</h4> <pre>public&nbsp;long&nbsp;getCount()</pre> </li> </ul> <a name="writeGlobal(org.apache.cassandra.utils.CounterId, long, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeGlobal</h4> <pre>public&nbsp;void&nbsp;writeGlobal(<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;id, long&nbsp;clock, long&nbsp;count)</pre> </li> </ul> <a name="writeLocal(org.apache.cassandra.utils.CounterId, long, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>writeLocal</h4> <pre>public&nbsp;void&nbsp;writeLocal(<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;id, long&nbsp;clock, long&nbsp;count)</pre> </li> </ul> <a name="writeRemote(org.apache.cassandra.utils.CounterId, long, long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>writeRemote</h4> <pre>public&nbsp;void&nbsp;writeRemote(<a href="../../../../../org/apache/cassandra/utils/CounterId.html" title="class in org.apache.cassandra.utils">CounterId</a>&nbsp;id, long&nbsp;clock, long&nbsp;count)</pre> </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/CounterContext.ContextState.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/db/context/CounterContext.html" title="class in org.apache.cassandra.db.context"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/context/CounterContext.Relationship.html" title="enum in org.apache.cassandra.db.context"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/context/CounterContext.ContextState.html" target="_top">Frames</a></li> <li><a href="CounterContext.ContextState.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="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li>Constr&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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>