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>CommitLogSegment (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/CommitLogSegment.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/CommitLogReplayer.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/CommitLogSegment.CommitLogSegmentFileComparator.html" title="class 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/CommitLogSegment.html" target="_top">Frames</a></li> <li><a href="CommitLogSegment.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><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li>Constr | </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.db.commitlog</div> <h2 title="Class CommitLogSegment" class="title">Class CommitLogSegment</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.commitlog.CommitLogSegment</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CommitLogSegment</span> extends java.lang.Object</pre> </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> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.CommitLogSegmentFileComparator.html" title="class in org.apache.cassandra.db.commitlog">CommitLogSegment.CommitLogSegmentFileComparator</a></strong></code> </td> </tr> </table> </li> </ul>  <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"> </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><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/CommitLogSegment.html#descriptor">descriptor</a></strong></code> </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/CommitLogSegment.html#ENTRY_OVERHEAD_SIZE">ENTRY_OVERHEAD_SIZE</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#id">id</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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#contains(org.apache.cassandra.db.commitlog.ReplayPosition)">contains</a></strong>(<a href="../../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a> context)</code> <div class="block">Check to see if a certain ReplayPosition is contained by this segment file.</div> </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/CommitLogSegment.html#dirtyString()">dirtyString</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#getContext()">getContext</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<java.util.UUID></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#getDirtyCFIDs()">getDirtyCFIDs</a></strong>()</code> </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/CommitLogSegment.html#getName()">getName</a></strong>()</code> </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/CommitLogSegment.html#getPath()">getPath</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#isStillAllocating()">isStillAllocating</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#isUnused()">isUnused</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogSegment.html#markClean(java.util.UUID,%20org.apache.cassandra.db.commitlog.ReplayPosition)">markClean</a></strong>(java.util.UUID cfId, <a href="../../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a> context)</code> <div class="block">Marks the ColumnFamily specified by cfId as clean for this log segment.</div> </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/CommitLogSegment.html#toString()">toString</a></strong>()</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, 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="field_detail">  </a> <h3>Field Detail</h3> <a name="ENTRY_OVERHEAD_SIZE">  </a> <ul class="blockList"> <li class="blockList"> <h4>ENTRY_OVERHEAD_SIZE</h4> <pre>public static final int ENTRY_OVERHEAD_SIZE</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.db.commitlog.CommitLogSegment.ENTRY_OVERHEAD_SIZE">Constant Field Values</a></dd></dl> </li> </ul> <a name="id">  </a> <ul class="blockList"> <li class="blockList"> <h4>id</h4> <pre>public final long id</pre> </li> </ul> <a name="descriptor">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>descriptor</h4> <pre>public final <a href="../../../../../org/apache/cassandra/db/commitlog/CommitLogDescriptor.html" title="class in org.apache.cassandra.db.commitlog">CommitLogDescriptor</a> descriptor</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="isStillAllocating()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isStillAllocating</h4> <pre>public boolean isStillAllocating()</pre> </li> </ul> <a name="getContext()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getContext</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a> getContext()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the current ReplayPosition for this log segment</dd></dl> </li> </ul> <a name="getPath()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPath</h4> <pre>public java.lang.String getPath()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the file path to this segment</dd></dl> </li> </ul> <a name="getName()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getName</h4> <pre>public java.lang.String getName()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the file name of this segment</dd></dl> </li> </ul> <a name="markClean(java.util.UUID, org.apache.cassandra.db.commitlog.ReplayPosition)">  </a> <ul class="blockList"> <li class="blockList"> <h4>markClean</h4> <pre>public void markClean(java.util.UUID cfId, <a href="../../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a> context)</pre> <div class="block">Marks the ColumnFamily specified by cfId as clean for this log segment. If the given context argument is contained in this file, it will only mark the CF as clean if no newer writes have taken place.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfId</code> - the column family ID that is now clean</dd><dd><code>context</code> - the optional clean offset</dd></dl> </li> </ul> <a name="getDirtyCFIDs()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getDirtyCFIDs</h4> <pre>public java.util.Collection<java.util.UUID> getDirtyCFIDs()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>a collection of dirty CFIDs for this segment file.</dd></dl> </li> </ul> <a name="isUnused()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isUnused</h4> <pre>public boolean isUnused()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true if this segment is unused and safe to recycle or delete</dd></dl> </li> </ul> <a name="contains(org.apache.cassandra.db.commitlog.ReplayPosition)">  </a> <ul class="blockList"> <li class="blockList"> <h4>contains</h4> <pre>public boolean contains(<a href="../../../../../org/apache/cassandra/db/commitlog/ReplayPosition.html" title="class in org.apache.cassandra.db.commitlog">ReplayPosition</a> context)</pre> <div class="block">Check to see if a certain ReplayPosition is contained by this segment file.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the replay position to be checked</dd> <dt><span class="strong">Returns:</span></dt><dd>true if the replay position is contained by this segment file.</dd></dl> </li> </ul> <a name="dirtyString()">  </a> <ul class="blockList"> <li class="blockList"> <h4>dirtyString</h4> <pre>public java.lang.String dirtyString()</pre> </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>   <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/CommitLogSegment.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/CommitLogReplayer.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/CommitLogSegment.CommitLogSegmentFileComparator.html" title="class 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/CommitLogSegment.html" target="_top">Frames</a></li> <li><a href="CommitLogSegment.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><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li>Constr | </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>