Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / api / windowing / evictors / TimeEvictionPolicy.html
blob: a31a5a3ac801b5dee4d8ef70674e29b153d26ae0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>TimeEvictionPolicy (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TimeEvictionPolicy (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.api.windowing.evictors</a></div>
<h2 title="Class TimeEvictionPolicy" class="title">Class TimeEvictionPolicy&lt;T extends java.io.Serializable&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.api.windowing.evictors.TimeEvictionPolicy&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;T,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="WatermarkTimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">WatermarkTimeEvictionPolicy</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">TimeEvictionPolicy&lt;T extends java.io.Serializable&gt;</span>
extends java.lang.Object
implements <a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;T,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</pre>
<div class="block">Eviction policy that evicts events based on time duration.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.heron.api.windowing.EvictionPolicy">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.heron.api.windowing.<a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a></h3>
<code><a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing">EvictionPolicy.Action</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#evictionContext">evictionContext</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(long)">TimeEvictionPolicy</a></span>&#8203;(long&nbsp;windowLength)</code></th>
<td class="colLast">
<div class="block">Constructs a TimeEvictionPolicy that evicts events older
than the given window length in millis</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing">EvictionPolicy.Action</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#evict(org.apache.heron.api.windowing.Event)">evict</a></span>&#8203;(<a href="../Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a>&gt;&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Decides if an event should be expired from the window, processed in the current
window or kept for later processing.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current context that is part of this eviction policy.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th>
<td class="colLast">
<div class="block">Return runtime state to be checkpointed by the framework for restoring the eviction policy
in case of failures.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the eviction policy.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#restoreState(org.apache.heron.api.windowing.EvictionContext)">restoreState</a></span>&#8203;(<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Restore the eviction policy from the state that was earlier checkpointed by the framework.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContext(org.apache.heron.api.windowing.EvictionContext)">setContext</a></span>&#8203;(<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Sets a context in the eviction policy that can be used while evicting the events.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#track(org.apache.heron.api.windowing.Event)">track</a></span>&#8203;(<a href="../Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a>&gt;&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Tracks the event to later decide whether
<a href="../EvictionPolicy.html#evict(org.apache.heron.api.windowing.Event)"><code>EvictionPolicy.evict(Event)</code></a> should evict it or not.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="evictionContext">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>evictionContext</h4>
<pre>protected volatile&nbsp;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a> evictionContext</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TimeEvictionPolicy</h4>
<pre>public&nbsp;TimeEvictionPolicy&#8203;(long&nbsp;windowLength)</pre>
<div class="block">Constructs a TimeEvictionPolicy that evicts events older
than the given window length in millis</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the duration in milliseconds</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="evict(org.apache.heron.api.windowing.Event)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evict</h4>
<pre class="methodSignature">public&nbsp;<a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing">EvictionPolicy.Action</a>&nbsp;evict&#8203;(<a href="../Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a>&gt;&nbsp;event)</pre>
<div class="block">Decides if an event should be expired from the window, processed in the current
window or kept for later processing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#evict(org.apache.heron.api.windowing.Event)">evict</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the input event</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing"><code>EvictionPolicy.Action</code></a> to be taken based on the input event</dd>
</dl>
</li>
</ul>
<a id="track(org.apache.heron.api.windowing.Event)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>track</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;track&#8203;(<a href="../Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a>&gt;&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../EvictionPolicy.html#track(org.apache.heron.api.windowing.Event)">EvictionPolicy</a></code></span></div>
<div class="block">Tracks the event to later decide whether
<a href="../EvictionPolicy.html#evict(org.apache.heron.api.windowing.Event)"><code>EvictionPolicy.evict(Event)</code></a> should evict it or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#track(org.apache.heron.api.windowing.Event)">track</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the input event to be tracked</dd>
</dl>
</li>
</ul>
<a id="setContext(org.apache.heron.api.windowing.EvictionContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContext</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setContext&#8203;(<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../EvictionPolicy.html#setContext(org.apache.heron.api.windowing.EvictionContext)">EvictionPolicy</a></code></span></div>
<div class="block">Sets a context in the eviction policy that can be used while evicting the events.
E.g. For TimeEvictionPolicy, this could be used to set the reference timestamp.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#setContext(org.apache.heron.api.windowing.EvictionContext)">setContext</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the eviction context</dd>
</dl>
</li>
</ul>
<a id="getContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre class="methodSignature">public&nbsp;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&nbsp;getContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../EvictionPolicy.html#getContext()">EvictionPolicy</a></code></span></div>
<div class="block">Returns the current context that is part of this eviction policy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#getContext()">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the eviction context</dd>
</dl>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../EvictionPolicy.html#reset()">EvictionPolicy</a></code></span></div>
<div class="block">Resets the eviction policy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#reset()">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="getState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre class="methodSignature">public&nbsp;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&nbsp;getState()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../EvictionPolicy.html#getState()">EvictionPolicy</a></code></span></div>
<div class="block">Return runtime state to be checkpointed by the framework for restoring the eviction policy
in case of failures.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#getState()">getState</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state</dd>
</dl>
</li>
</ul>
<a id="restoreState(org.apache.heron.api.windowing.EvictionContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restoreState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;restoreState&#8203;(<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../EvictionPolicy.html#restoreState(S)">EvictionPolicy</a></code></span></div>
<div class="block">Restore the eviction policy from the state that was earlier checkpointed by the framework.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../EvictionPolicy.html#restoreState(S)">restoreState</a></code>&nbsp;in interface&nbsp;<code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="TimeEvictionPolicy.html" title="type parameter in TimeEvictionPolicy">T</a> extends java.io.Serializable,&#8203;<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - the state</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>