cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
338 lines (336 loc) • 17.2 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:28 CEST 2014 -->
<title>ExpiringCell (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="ExpiringCell (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/ExpiringCell.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/Directories.SSTableLister.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/db/HintedHandOffManager.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/ExpiringCell.html" target="_top">Frames</a></li>
<li><a href="ExpiringCell.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: </li>
<li>Nested | </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.db</div>
<h2 title="Interface ExpiringCell" class="title">Interface ExpiringCell</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>, <a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cassandra/db/BufferExpiringCell.html" title="class in org.apache.cassandra.db">BufferExpiringCell</a>, <a href="../../../../org/apache/cassandra/db/NativeExpiringCell.html" title="class in org.apache.cassandra.db">NativeExpiringCell</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ExpiringCell</span>
extends <a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></pre>
<div class="block">Alternative to Cell that have an expiring time.
ExpiringCell is immutable (as Cell is).
Note that ExpiringCell does not override Cell.getMarkedForDeleteAt,
which means that it's in the somewhat unintuitive position of being deleted (after its expiration)
without having a time-at-which-it-became-deleted. (Because ttl is a server-side measurement,
we can't mix it with the timestamp field, which is client-supplied and whose resolution we
can't assume anything about.)</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<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.db.OnDiskAtom">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface org.apache.cassandra.db.<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a></h3>
<code><a href="../../../../org/apache/cassandra/db/OnDiskAtom.Serializer.html" title="class in org.apache.cassandra.db">OnDiskAtom.Serializer</a></code></li>
</ul>
</li>
</ul>
<!-- =========== 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"> </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/ExpiringCell.html#MAX_TTL">MAX_TTL</a></strong></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.Cell">
<!-- -->
</a>
<h3>Fields inherited from interface org.apache.cassandra.db.<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></h3>
<code><a href="../../../../org/apache/cassandra/db/Cell.html#MAX_NAME_LENGTH">MAX_NAME_LENGTH</a></code></li>
</ul>
</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"> </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/ExpiringCell.html#getTimeToLive()">getTimeToLive</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ExpiringCell.html" title="interface in org.apache.cassandra.db">ExpiringCell</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ExpiringCell.html#localCopy(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.utils.memory.AbstractAllocator)">localCopy</a></strong>(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata,
<a href="../../../../org/apache/cassandra/utils/memory/AbstractAllocator.html" title="class in org.apache.cassandra.utils.memory">AbstractAllocator</a> allocator)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ExpiringCell.html" title="interface in org.apache.cassandra.db">ExpiringCell</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ExpiringCell.html#localCopy(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.utils.memory.MemtableAllocator,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">localCopy</a></strong>(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metaData,
<a href="../../../../org/apache/cassandra/utils/memory/MemtableAllocator.html" title="class in org.apache.cassandra.utils.memory">MemtableAllocator</a> allocator,
<a href="../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.Cell">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.cassandra.db.<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></h3>
<code><a href="../../../../org/apache/cassandra/db/Cell.html#cellDataSize()">cellDataSize</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#diff(org.apache.cassandra.db.Cell)">diff</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#getString(org.apache.cassandra.db.composites.CellNameType)">getString</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#isLive()">isLive</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#isLive(long)">isLive</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#name()">name</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#reconcile(org.apache.cassandra.db.Cell)">reconcile</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#serializationFlags()">serializationFlags</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#serializedSize(org.apache.cassandra.db.composites.CellNameType,%20org.apache.cassandra.db.TypeSizes)">serializedSize</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#unsharedHeapSizeExcludingData()">unsharedHeapSizeExcludingData</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#value()">value</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#withUpdatedName(org.apache.cassandra.db.composites.CellName)">withUpdatedName</a>, <a href="../../../../org/apache/cassandra/db/Cell.html#withUpdatedTimestamp(long)">withUpdatedTimestamp</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.OnDiskAtom">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.cassandra.db.<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a></h3>
<code><a href="../../../../org/apache/cassandra/db/OnDiskAtom.html#getLocalDeletionTime()">getLocalDeletionTime</a>, <a href="../../../../org/apache/cassandra/db/OnDiskAtom.html#timestamp()">timestamp</a>, <a href="../../../../org/apache/cassandra/db/OnDiskAtom.html#updateDigest(java.security.MessageDigest)">updateDigest</a>, <a href="../../../../org/apache/cassandra/db/OnDiskAtom.html#validateFields(org.apache.cassandra.config.CFMetaData)">validateFields</a></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="MAX_TTL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_TTL</h4>
<pre>static final int MAX_TTL</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.db.ExpiringCell.MAX_TTL">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTimeToLive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeToLive</h4>
<pre>int getTimeToLive()</pre>
</li>
</ul>
<a name="localCopy(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.utils.memory.AbstractAllocator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localCopy</h4>
<pre><a href="../../../../org/apache/cassandra/db/ExpiringCell.html" title="interface in org.apache.cassandra.db">ExpiringCell</a> localCopy(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata,
<a href="../../../../org/apache/cassandra/utils/memory/AbstractAllocator.html" title="class in org.apache.cassandra.utils.memory">AbstractAllocator</a> allocator)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/db/Cell.html#localCopy(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.utils.memory.AbstractAllocator)">localCopy</a></code> in interface <code><a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></dd>
</dl>
</li>
</ul>
<a name="localCopy(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.utils.memory.MemtableAllocator, org.apache.cassandra.utils.concurrent.OpOrder.Group)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>localCopy</h4>
<pre><a href="../../../../org/apache/cassandra/db/ExpiringCell.html" title="interface in org.apache.cassandra.db">ExpiringCell</a> localCopy(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metaData,
<a href="../../../../org/apache/cassandra/utils/memory/MemtableAllocator.html" title="class in org.apache.cassandra.utils.memory">MemtableAllocator</a> allocator,
<a href="../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/db/Cell.html#localCopy(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.utils.memory.MemtableAllocator,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">localCopy</a></code> in interface <code><a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></dd>
</dl>
</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/ExpiringCell.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/Directories.SSTableLister.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/db/HintedHandOffManager.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/ExpiringCell.html" target="_top">Frames</a></li>
<li><a href="ExpiringCell.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: </li>
<li>Nested | </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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>