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>DeletionTime (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/DeletionTime.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/DeletionInfo.Serializer.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/DeletionTime.Serializer.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/DeletionTime.html" target="_top">Frames</a></li> <li><a href="DeletionTime.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><a href="#constructor_summary">Constr</a> | </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><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.db</div> <h2 title="Class DeletionTime" class="title">Class DeletionTime</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.DeletionTime</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.lang.Comparable<<a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a>>, <a href="../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">DeletionTime</span> extends java.lang.Object implements java.lang.Comparable<<a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a>>, <a href="../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></pre> <div class="block">A top-level (row) tombstone.</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> <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/DeletionTime.Serializer.html" title="class in org.apache.cassandra.db">DeletionTime.Serializer</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>static <a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#LIVE">LIVE</a></strong></code> <div class="block">A special DeletionTime that signifies that there is no top-level (row) tombstone.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#localDeletionTime">localDeletionTime</a></strong></code> <div class="block">The local server timestamp, in seconds since the unix epoch, at which this tombstone was created.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#markedForDeleteAt">markedForDeleteAt</a></strong></code> <div class="block">A timestamp (typically in microseconds since the unix epoch, although this is not enforced) after which data should be considered deleted.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/db/DeletionTime.Serializer.html" title="class in org.apache.cassandra.db">DeletionTime.Serializer</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#serializer">serializer</a></strong></code> </td> </tr> </table> </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/db/DeletionTime.html#DeletionTime(long,%20int)">DeletionTime</a></strong>(long markedForDeleteAt, int localDeletionTime)</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>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#compareTo(org.apache.cassandra.db.DeletionTime)">compareTo</a></strong>(<a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a> dt)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.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="../../../../org/apache/cassandra/db/DeletionTime.html#isDeleted(org.apache.cassandra.db.OnDiskAtom)">isDeleted</a></strong>(<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> atom)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#isGcAble(int)">isGcAble</a></strong>(int gcBefore)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#isLive()">isLive</a></strong>()</code> <div class="block">Returns whether this DeletionTime is live, that is deletes no columns.</div> </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/DeletionTime.html#toString()">toString</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DeletionTime.html#unsharedHeapSize()">unsharedHeapSize</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, finalize, getClass, 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="LIVE">  </a> <ul class="blockList"> <li class="blockList"> <h4>LIVE</h4> <pre>public static final <a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a> LIVE</pre> <div class="block">A special DeletionTime that signifies that there is no top-level (row) tombstone.</div> </li> </ul> <a name="markedForDeleteAt">  </a> <ul class="blockList"> <li class="blockList"> <h4>markedForDeleteAt</h4> <pre>public final long markedForDeleteAt</pre> <div class="block">A timestamp (typically in microseconds since the unix epoch, although this is not enforced) after which data should be considered deleted. If set to Long.MIN_VALUE, this implies that the data has not been marked for deletion at all.</div> </li> </ul> <a name="localDeletionTime">  </a> <ul class="blockList"> <li class="blockList"> <h4>localDeletionTime</h4> <pre>public final int localDeletionTime</pre> <div class="block">The local server timestamp, in seconds since the unix epoch, at which this tombstone was created. This is only used for purposes of purging the tombstone after gc_grace_seconds have elapsed.</div> </li> </ul> <a name="serializer">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>serializer</h4> <pre>public static final <a href="../../../../org/apache/cassandra/db/DeletionTime.Serializer.html" title="class in org.apache.cassandra.db">DeletionTime.Serializer</a> serializer</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="DeletionTime(long, int)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>DeletionTime</h4> <pre>public DeletionTime(long markedForDeleteAt, int localDeletionTime)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="isLive()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isLive</h4> <pre>public boolean isLive()</pre> <div class="block">Returns whether this DeletionTime is live, that is deletes no columns.</div> </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 o)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="hashCode()">  </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public final 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="toString()">  </a> <ul class="blockList"> <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> <a name="compareTo(org.apache.cassandra.db.DeletionTime)">  </a> <ul class="blockList"> <li class="blockList"> <h4>compareTo</h4> <pre>public int compareTo(<a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a> dt)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/apache/cassandra/db/DeletionTime.html" title="class in org.apache.cassandra.db">DeletionTime</a>></code></dd> </dl> </li> </ul> <a name="isGcAble(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isGcAble</h4> <pre>public boolean isGcAble(int gcBefore)</pre> </li> </ul> <a name="isDeleted(org.apache.cassandra.db.OnDiskAtom)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isDeleted</h4> <pre>public boolean isDeleted(<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> atom)</pre> </li> </ul> <a name="unsharedHeapSize()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>unsharedHeapSize</h4> <pre>public long unsharedHeapSize()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cache/IMeasurableMemory.html#unsharedHeapSize()">unsharedHeapSize</a></code> in interface <code><a href="../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the amount of on-heap memory retained by the object that might be reclaimed if the object were reclaimed, i.e. it should try to exclude globally cached data where possible, or counting portions of arrays that are referenced by the object but used by other objects only (e.g. slabbed byte-buffers), etc.</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/DeletionTime.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/DeletionInfo.Serializer.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/DeletionTime.Serializer.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/DeletionTime.html" target="_top">Frames</a></li> <li><a href="DeletionTime.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><a href="#constructor_summary">Constr</a> | </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><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>