UNPKG

cassandra-server

Version:

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

469 lines (468 loc) 18.1 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>CommitLogDescriptor (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="CommitLogDescriptor (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/CommitLogDescriptor.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/commitlog/CommitLogArchiver.html" title="class in org.apache.cassandra.db.commitlog"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html" title="interface in org.apache.cassandra.db.commitlog"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" target="_top">Frames</a></li> <li><a href="CommitLogDescriptor.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.commitlog</div> <h2 title="Class CommitLogDescriptor" class="title">Class CommitLogDescriptor</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.commitlog.CommitLogDescriptor</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CommitLogDescriptor</span> extends java.lang.Object</pre> </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>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#current_version">current_version</a></strong></code> <div class="block">Increment this number if there is a changes in the commit log disc layout or MessagingVersion changes.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#id">id</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#VERSION_12">VERSION_12</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#VERSION_20">VERSION_20</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#VERSION_21">VERSION_21</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <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">&nbsp;</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/db/commitlog/CommitLogDescriptor.html#CommitLogDescriptor(int,%20long)">CommitLogDescriptor</a></strong>(int&nbsp;version, long&nbsp;id)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#CommitLogDescriptor(long)">CommitLogDescriptor</a></strong>(long&nbsp;id)</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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#equals(org.apache.cassandra.db.commitlog.CommitLogDescriptor)">equals</a></strong>(<a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a>&nbsp;that)</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/commitlog/CommitLogDescriptor.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;that)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#fileName()">fileName</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#fromFileName(java.lang.String)">fromFileName</a></strong>(java.lang.String&nbsp;name)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#fromHeader(java.io.File)">fromHeader</a></strong>(java.io.File&nbsp;file)</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/commitlog/CommitLogDescriptor.html#getMessagingVersion()">getMessagingVersion</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#isValid(java.lang.String)">isValid</a></strong>(java.lang.String&nbsp;filename)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#toString()">toString</a></strong>()</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, finalize, getClass, hashCode, notify, notifyAll, 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="VERSION_12"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>VERSION_12</h4> <pre>public static final&nbsp;int VERSION_12</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.commitlog.CommitLogDescriptor.VERSION_12">Constant Field Values</a></dd></dl> </li> </ul> <a name="VERSION_20"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>VERSION_20</h4> <pre>public static final&nbsp;int VERSION_20</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.commitlog.CommitLogDescriptor.VERSION_20">Constant Field Values</a></dd></dl> </li> </ul> <a name="VERSION_21"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>VERSION_21</h4> <pre>public static final&nbsp;int VERSION_21</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.commitlog.CommitLogDescriptor.VERSION_21">Constant Field Values</a></dd></dl> </li> </ul> <a name="current_version"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>current_version</h4> <pre>public static final&nbsp;int current_version</pre> <div class="block">Increment this number if there is a changes in the commit log disc layout or MessagingVersion changes. Note: make sure to handle <a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html#getMessagingVersion()"><code>getMessagingVersion()</code></a></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.commitlog.CommitLogDescriptor.current_version">Constant Field Values</a></dd></dl> </li> </ul> <a name="id"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>id</h4> <pre>public final&nbsp;long id</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="CommitLogDescriptor(int, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>CommitLogDescriptor</h4> <pre>public&nbsp;CommitLogDescriptor(int&nbsp;version, long&nbsp;id)</pre> </li> </ul> <a name="CommitLogDescriptor(long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CommitLogDescriptor</h4> <pre>public&nbsp;CommitLogDescriptor(long&nbsp;id)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="fromHeader(java.io.File)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fromHeader</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a>&nbsp;fromHeader(java.io.File&nbsp;file)</pre> </li> </ul> <a name="fromFileName(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fromFileName</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a>&nbsp;fromFileName(java.lang.String&nbsp;name)</pre> </li> </ul> <a name="getMessagingVersion()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMessagingVersion</h4> <pre>public&nbsp;int&nbsp;getMessagingVersion()</pre> </li> </ul> <a name="fileName()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fileName</h4> <pre>public&nbsp;java.lang.String&nbsp;fileName()</pre> </li> </ul> <a name="isValid(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isValid</h4> <pre>public static&nbsp;boolean&nbsp;isValid(java.lang.String&nbsp;filename)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the filename to check</dd> <dt><span class="strong">Returns:</span></dt><dd>true if filename could be a commit log based on it's filename</dd></dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<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&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;that)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="equals(org.apache.cassandra.db.commitlog.CommitLogDescriptor)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>equals</h4> <pre>public&nbsp;boolean&nbsp;equals(<a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a>&nbsp;that)</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/CommitLogDescriptor.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/commitlog/CommitLogArchiver.html" title="class in org.apache.cassandra.db.commitlog"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogMBean.html" title="interface in org.apache.cassandra.db.commitlog"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" target="_top">Frames</a></li> <li><a href="CommitLogDescriptor.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>