http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html new file mode 100644 index 0000000..e13bcf4 --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html @@ -0,0 +1,458 @@ +<!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 (1.8.0_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DefaultTriggerStateMachine (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DefaultTriggerStateMachine (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/DefaultTriggerStateMachine.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/beam/runners/core/triggers/AfterWatermarkStateMachine.FromEndOfWindow.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html" target="_top">Frames</a></li> +<li><a href="DefaultTriggerStateMachine.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><a href="#nested.classes.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.beam.runners.core.triggers</div> +<h2 title="Class DefaultTriggerStateMachine" class="title">Class DefaultTriggerStateMachine</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">org.apache.beam.runners.core.triggers.TriggerStateMachine</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.triggers.DefaultTriggerStateMachine</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#TRIGGER">TRIGGER</a>) +public class <span class="typeNameLabel">DefaultTriggerStateMachine</span> +extends <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></pre> +<div class="block">A trigger that is equivalent to <code>Repeatedly.forever(AfterWatermark.pastEndOfWindow())</code>. See + <a href="../../../../../../org/apache/beam/runners/core/triggers/RepeatedlyStateMachine.html#forever-org.apache.beam.runners.core.triggers.TriggerStateMachine-"><code>RepeatedlyStateMachine.forever(org.apache.beam.runners.core.triggers.TriggerStateMachine)</code></a> and <a href="../../../../../../org/apache/beam/runners/core/triggers/AfterWatermarkStateMachine.html#pastEndOfWindow--"><code>AfterWatermarkStateMachine.pastEndOfWindow()</code></a> for + more details.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.core.triggers.DefaultTriggerStateMachine">Serialized Form</a></dd> +</dl> +</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.beam.runners.core.triggers.TriggerStateMachine"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.MergingTriggerInfo</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.tr iggers">TriggerStateMachine.TriggerContext</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerInfo</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#subTriggers">subTriggers</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#clear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">clear</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c)</code> +<div class="block">Clear any state associated with this trigger in the given window.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#isCompatible-org.apache.beam.runners.core.triggers.TriggerStateMachine-">isCompatible</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a> other)</code> +<div class="block">Returns whether this performs the same triggering as the given <code>Trigger</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">DefaultTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#of--">of</a></span>()</code> +<div class="block">Returns the default trigger.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">onElement</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a> c)</code> +<div class="block">Called every time an element is incorporated into a window.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">onFire</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context)</code> +<div class="block">Adjusts the state of the trigger to be ready for the next pane.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">onMerge</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a> c)</code> +<div class="block">Called immediately after windows have been merged.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">shouldFire</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context)</code> +<div class="block">Returns <code>true</code> if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#orFinally-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine-">orFinally</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchOnElement-org.apache.beam.sdk.util.state.StateAccessor-">prefetchOnElement</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchOnFire-org.apache.beam.sdk.util.state.StateAccessor-">prefetchOnFire</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchOnMerge-org.apache.beam.sdk.util.state.MergingStateAccessor-">prefetchOnMerge</a>, <a href="../../.. /../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchShouldFire-org.apache.beam.sdk.util.state.StateAccessor-">prefetchShouldFire</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#subTriggers--">subTriggers</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-ex ternal=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="of--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">DefaultTriggerStateMachine</a> of()</pre> +<div class="block">Returns the default trigger.</div> +</li> +</ul> +<a name="onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onElement</h4> +<pre>public void onElement(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Called every time an element is incorporated into a window.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">onElement</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onMerge</h4> +<pre>public void onMerge(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Called immediately after windows have been merged. + + <p>Leaf triggers should update their state by inspecting their status and any state in the + merging windows. Composite triggers should update their state by calling <a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeOnMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"><code>ExecutableTriggerStateMachine.invokeOnMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext)</code></a> on their sub-triggers, and applying appropriate + logic. + + <p>A trigger such as <a href="../../../../../../org/apache/beam/runners/core/triggers/AfterWatermarkStateMachine.html#pastEndOfWindow--"><code>AfterWatermarkStateMachine.pastEndOfWindow()</code></a> may no longer be + finished; it is the responsibility of the trigger itself to record this fact. It is forbidden + for a trigger to become finished due to <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"><code>TriggerStateMachine.onMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext)</code></a>, as it has not yet fired the pending + elements that led to it being ready to fire. + + <p>The implementation does not need to clear out any state associated with the old windows.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">onMerge</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="clear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#clear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Clear any state associated with this trigger in the given window. + + <p>This is called after a trigger has indicated it will never fire again. The trigger system + keeps enough information to know that the trigger is finished, so this trigger should clear all + of its state.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#clear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">clear</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="isCompatible-org.apache.beam.runners.core.triggers.TriggerStateMachine-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCompatible</h4> +<pre>public boolean isCompatible(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a> other)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#isCompatible-org.apache.beam.runners.core.triggers.TriggerStateMachine-">TriggerStateMachine</a></code></span></div> +<div class="block">Returns whether this performs the same triggering as the given <code>Trigger</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#isCompatible-org.apache.beam.runners.core.triggers.TriggerStateMachine-">isCompatible</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +</dl> +</li> +</ul> +<a name="shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldFire</h4> +<pre>public boolean shouldFire(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Returns <code>true</code> if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">shouldFire</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onFire</h4> +<pre>public void onFire(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Adjusts the state of the trigger to be ready for the next pane. For example, a + <a href="../../../../../../org/apache/beam/runners/core/triggers/RepeatedlyStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><code>RepeatedlyStateMachine</code></a> trigger will reset its inner trigger, since it has fired. + + <p>If the trigger is finished, it is the responsibility of the trigger itself to + record that fact via the <code>context</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">onFire</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/DefaultTriggerStateMachine.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/beam/runners/core/triggers/AfterWatermarkStateMachine.FromEndOfWindow.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/DefaultTriggerStateMachine.html" target="_top">Frames</a></li> +<li><a href="DefaultTriggerStateMachine.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><a href="#nested.classes.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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 © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html new file mode 100644 index 0000000..21579a0 --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html @@ -0,0 +1,467 @@ +<!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 (1.8.0_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ExecutableTriggerStateMachine (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ExecutableTriggerStateMachine (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/ExecutableTriggerStateMachine.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/beam/runners/core/triggers/DefaultTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html" title="interface in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" target="_top">Frames</a></li> +<li><a href="ExecutableTriggerStateMachine.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.beam.runners.core.triggers</div> +<h2 title="Class ExecutableTriggerStateMachine" class="title">Class ExecutableTriggerStateMachine</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ExecutableTriggerStateMachine</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></pre> +<div class="block">A wrapper around a trigger used during execution. While an actual trigger may appear multiple + times (both in the same trigger expression and in other trigger expressions), the + <code>ExecutableTrigger</code> wrapped around them forms a tree (only one occurrence).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#create-org.apache.beam.runners.core.triggers.TriggerStateMachine-">create</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a> trigger)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#createForOnceTrigger-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine-int-">createForOnceTrigger</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a> trigger, + int nextUnusedIndex)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#getFirstIndexAfterSubtree--">getFirstIndexAfterSubtree</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#getSpec--">getSpec</a></span>()</code> +<div class="block">Return the underlying trigger specification corresponding to this <code>ExecutableTrigger</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#getSubTriggerContaining-int-">getSubTriggerContaining</a></span>(int index)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#getTriggerIndex--">getTriggerIndex</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeClear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">invokeClear</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c)</code> +<div class="block">Invoke clear for the current this trigger.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeOnElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">invokeOnElement</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a> c)</code> +<div class="block">Invoke the <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-"><code>TriggerStateMachine.onElement(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext)</code></a> method for this trigger, ensuring that the + bits are properly updated if the trigger finishes.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeOnFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">invokeOnFire</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeOnMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">invokeOnMerge</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a> c)</code> +<div class="block">Invoke the <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"><code>TriggerStateMachine.onMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext)</code></a> method for this trigger, ensuring that the bits + are properly updated.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeShouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">invokeShouldFire</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c)</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#isCompatible-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-">isCompatible</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> other)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#subTriggers--">subTriggers</a></span>()</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#toString--">toString</a></span>()</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-org.apache.beam.runners.core.triggers.TriggerStateMachine-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> <a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> create(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a> trigger)</pre> +</li> +</ul> +<a name="createForOnceTrigger-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createForOnceTrigger</h4> +<pre>public static <W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> <a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> createForOnceTrigger(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a> trigger, + int nextUnusedIndex)</pre> +</li> +</ul> +<a name="subTriggers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subTriggers</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a>> subTriggers()</pre> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="getSpec--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpec</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a> getSpec()</pre> +<div class="block">Return the underlying trigger specification corresponding to this <code>ExecutableTrigger</code>.</div> +</li> +</ul> +<a name="getTriggerIndex--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTriggerIndex</h4> +<pre>public int getTriggerIndex()</pre> +</li> +</ul> +<a name="getFirstIndexAfterSubtree--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFirstIndexAfterSubtree</h4> +<pre>public final int getFirstIndexAfterSubtree()</pre> +</li> +</ul> +<a name="isCompatible-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCompatible</h4> +<pre>public boolean isCompatible(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> other)</pre> +</li> +</ul> +<a name="getSubTriggerContaining-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubTriggerContaining</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> getSubTriggerContaining(int index)</pre> +</li> +</ul> +<a name="invokeOnElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeOnElement</h4> +<pre>public void invokeOnElement(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Invoke the <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-"><code>TriggerStateMachine.onElement(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext)</code></a> method for this trigger, ensuring that the + bits are properly updated if the trigger finishes.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="invokeOnMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeOnMerge</h4> +<pre>public void invokeOnMerge(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Invoke the <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"><code>TriggerStateMachine.onMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext)</code></a> method for this trigger, ensuring that the bits + are properly updated.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="invokeShouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeShouldFire</h4> +<pre>public boolean invokeShouldFire(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="invokeOnFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeOnFire</h4> +<pre>public void invokeOnFire(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="invokeClear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>invokeClear</h4> +<pre>public void invokeClear(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Invoke clear for the current this trigger.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/ExecutableTriggerStateMachine.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/beam/runners/core/triggers/DefaultTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html" title="interface in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" target="_top">Frames</a></li> +<li><a href="ExecutableTriggerStateMachine.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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 © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/FinishedTriggers.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/FinishedTriggers.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/FinishedTriggers.html new file mode 100644 index 0000000..dab85f7 --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/triggers/FinishedTriggers.html @@ -0,0 +1,282 @@ +<!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 (1.8.0_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FinishedTriggers (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FinishedTriggers (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/FinishedTriggers.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/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggersBitSet.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/FinishedTriggers.html" target="_top">Frames</a></li> +<li><a href="FinishedTriggers.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.beam.runners.core.triggers</div> +<h2 title="Interface FinishedTriggers" class="title">Interface FinishedTriggers</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggersBitSet.html" title="class in org.apache.beam.runners.core.triggers">FinishedTriggersBitSet</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggersSet.html" title="class in org.apache.beam.runners.core.triggers">FinishedTriggersSet</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">FinishedTriggers</span></pre> +<div class="block">A mutable set which tracks whether any particular <a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><code>ExecutableTriggerStateMachine</code></a> is + finished.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html#clearRecursively-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-">clearRecursively</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger)</code> +<div class="block">Sets the trigger and all of its subtriggers to unfinished.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html" title="interface in org.apache.beam.runners.core.triggers">FinishedTriggers</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html#copy--">copy</a></span>()</code> +<div class="block">Create an independent copy of this mutable <a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html" title="interface in org.apache.beam.runners.core.triggers"><code>FinishedTriggers</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html#isFinished-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-">isFinished</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger)</code> +<div class="block">Returns <code>true</code> if the trigger is finished.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html#setFinished-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-boolean-">setFinished</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger, + boolean value)</code> +<div class="block">Sets the fact that the trigger is finished.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isFinished-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFinished</h4> +<pre>boolean isFinished(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger)</pre> +<div class="block">Returns <code>true</code> if the trigger is finished.</div> +</li> +</ul> +<a name="setFinished-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFinished</h4> +<pre>void setFinished(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger, + boolean value)</pre> +<div class="block">Sets the fact that the trigger is finished.</div> +</li> +</ul> +<a name="clearRecursively-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearRecursively</h4> +<pre>void clearRecursively(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger)</pre> +<div class="block">Sets the trigger and all of its subtriggers to unfinished.</div> +</li> +</ul> +<a name="copy--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>copy</h4> +<pre><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html" title="interface in org.apache.beam.runners.core.triggers">FinishedTriggers</a> copy()</pre> +<div class="block">Create an independent copy of this mutable <a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggers.html" title="interface in org.apache.beam.runners.core.triggers"><code>FinishedTriggers</code></a>.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/FinishedTriggers.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/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/FinishedTriggersBitSet.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/FinishedTriggers.html" target="_top">Frames</a></li> +<li><a href="FinishedTriggers.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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 © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
