You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by ca...@apache.org on 2016/05/20 01:24:12 UTC
[39/56] [abbrv] [partial] incubator-quarks-website git commit: Add
javadoc init for "lastest", "0.4"
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/9f47ca2f/site/javadoc/lastest/quarks/connectors/file/FileWriterCycleConfig.html
----------------------------------------------------------------------
diff --git a/site/javadoc/lastest/quarks/connectors/file/FileWriterCycleConfig.html b/site/javadoc/lastest/quarks/connectors/file/FileWriterCycleConfig.html
new file mode 100644
index 0000000..4d23cdb
--- /dev/null
+++ b/site/javadoc/lastest/quarks/connectors/file/FileWriterCycleConfig.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_71) on Tue May 17 00:28:45 UTC 2016 -->
+<title>FileWriterCycleConfig (Quarks v0.4.0)</title>
+<meta name="date" content="2016-05-17">
+<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="FileWriterCycleConfig (Quarks v0.4.0)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":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/FileWriterCycleConfig.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="../../../quarks/connectors/file/FileStreams.html" title="class in quarks.connectors.file"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?quarks/connectors/file/FileWriterCycleConfig.html" target="_top">Frames</a></li>
+<li><a href="FileWriterCycleConfig.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">quarks.connectors.file</div>
+<h2 title="Class FileWriterCycleConfig" class="title">Class FileWriterCycleConfig<T></h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>quarks.connectors.file.FileWriterCycleConfig<T></li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt><span class="paramLabel">Type Parameters:</span></dt>
+<dd><code>T</code> - stream tuple type</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">FileWriterCycleConfig<T></span>
+extends java.lang.Object</pre>
+<div class="block">FileWriter active file cycle configuration control.
+ <p>
+ Cycling the active file closes it, gets it to its final pathname,
+ and induces the application of a retention policy
+ <a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file"><code>FileWriterRetentionConfig</code></a>.
+ <p>
+ Cycling the active file can be any combination of:
+ <ul>
+ <li>after <code>fileSize</code> bytes have been written</li>
+ <li>after every <code>cntTuple</code> tuples written</li>
+ <li>after <code>tuplePredicate</code> returns true</li>
+ <li>after <code>periodMsec</code> has elapsed since the last time based cycle</li>
+ </ul></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="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>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#evaluate-long-int-T-">evaluate</a></span>(long fileSize,
+ int nTuples,
+ <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="type parameter in FileWriterCycleConfig">T</a> tuple)</code>
+<div class="block">Evaluate if the specified values indicate that a cycling of
+ the active file should be performed.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#getCntTuples--">getCntTuples</a></span>()</code>
+<div class="block">Get the tuple count configuration value.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#getFileSize--">getFileSize</a></span>()</code>
+<div class="block">Get the file size configuration value.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#getPeriodMsec--">getPeriodMsec</a></span>()</code>
+<div class="block">Get the time period configuration value.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code><a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><<a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="type parameter in FileWriterCycleConfig">T</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#getTuplePredicate--">getTuplePredicate</a></span>()</code>
+<div class="block">Get the tuple predicate configuration value.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#newConfig-long-int-long-quarks.function.Predicate-">newConfig</a></span>(long fileSize,
+ int cntTuples,
+ long periodMsec,
+ <a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</code>
+<div class="block">Create a new configuration.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#newCountBasedConfig-int-">newCountBasedConfig</a></span>(int cntTuples)</code>
+<div class="block">same as <code>newConfig0, cntTuples, 0, null)</code></div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#newFileSizeBasedConfig-long-">newFileSizeBasedConfig</a></span>(long fileSize)</code>
+<div class="block">same as <code>newConfig(fileSize, 0, 0, null)</code></div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#newPredicateBasedConfig-quarks.function.Predicate-">newPredicateBasedConfig</a></span>(<a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</code>
+<div class="block">same as <code>newConfig(0, 0, 0, tuplePredicate)</code></div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html#newTimeBasedConfig-long-">newTimeBasedConfig</a></span>(long periodMsec)</code>
+<div class="block">same as <code>newConfig(0, 0, periodMsec, null)</code></div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterCycleConfig.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.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="newFileSizeBasedConfig-long-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newFileSizeBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T> newFileSizeBasedConfig(long fileSize)</pre>
+<div class="block">same as <code>newConfig(fileSize, 0, 0, null)</code></div>
+</li>
+</ul>
+<a name="newCountBasedConfig-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newCountBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T> newCountBasedConfig(int cntTuples)</pre>
+<div class="block">same as <code>newConfig0, cntTuples, 0, null)</code></div>
+</li>
+</ul>
+<a name="newTimeBasedConfig-long-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newTimeBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T> newTimeBasedConfig(long periodMsec)</pre>
+<div class="block">same as <code>newConfig(0, 0, periodMsec, null)</code></div>
+</li>
+</ul>
+<a name="newPredicateBasedConfig-quarks.function.Predicate-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newPredicateBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T> newPredicateBasedConfig(<a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</pre>
+<div class="block">same as <code>newConfig(0, 0, 0, tuplePredicate)</code></div>
+</li>
+</ul>
+<a name="newConfig-long-int-long-quarks.function.Predicate-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><T> newConfig(long fileSize,
+ int cntTuples,
+ long periodMsec,
+ <a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</pre>
+<div class="block">Create a new configuration.
+ <p>
+ At least one configuration mode must be enabled.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>fileSize</code> - cycle after <code>fileSize</code> bytes have been written. 0 to disable.</dd>
+<dd><code>cntTuples</code> - cycle after every <code>cntTuple</code> tuples have been written. 0 to disable.</dd>
+<dd><code>periodMsec</code> - cycle after <code>periodMsec</code> has elapsed since the last time based cycle. 0 to disable.</dd>
+<dd><code>tuplePredicate</code> - cycle if <code>tuplePredicate</code> returns true. null to disable.</dd>
+</dl>
+</li>
+</ul>
+<a name="getFileSize--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getFileSize</h4>
+<pre>public long getFileSize()</pre>
+<div class="block">Get the file size configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="getCntTuples--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCntTuples</h4>
+<pre>public int getCntTuples()</pre>
+<div class="block">Get the tuple count configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="getPeriodMsec--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPeriodMsec</h4>
+<pre>public long getPeriodMsec()</pre>
+<div class="block">Get the time period configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="getTuplePredicate--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTuplePredicate</h4>
+<pre>public <a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><<a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="type parameter in FileWriterCycleConfig">T</a>> getTuplePredicate()</pre>
+<div class="block">Get the tuple predicate configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="evaluate-long-int-java.lang.Object-">
+<!-- -->
+</a><a name="evaluate-long-int-T-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>evaluate</h4>
+<pre>public boolean evaluate(long fileSize,
+ int nTuples,
+ <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="type parameter in FileWriterCycleConfig">T</a> tuple)</pre>
+<div class="block">Evaluate if the specified values indicate that a cycling of
+ the active file should be performed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>fileSize</code> - the number of bytes written to the active file</dd>
+<dd><code>nTuples</code> - number of tuples written to the active file</dd>
+<dd><code>tuple</code> - the tuple written to the file</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if a cycle action should be performed.</dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public java.lang.String toString()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toString</code> in class <code>java.lang.Object</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/FileWriterCycleConfig.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 class="aboutLanguage"><a href="http://quarks.incubator.apache.org">Apache Quarks (incubating)</a></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../quarks/connectors/file/FileStreams.html" title="class in quarks.connectors.file"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?quarks/connectors/file/FileWriterCycleConfig.html" target="_top">Frames</a></li>
+<li><a href="FileWriterCycleConfig.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 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/9f47ca2f/site/javadoc/lastest/quarks/connectors/file/FileWriterFlushConfig.html
----------------------------------------------------------------------
diff --git a/site/javadoc/lastest/quarks/connectors/file/FileWriterFlushConfig.html b/site/javadoc/lastest/quarks/connectors/file/FileWriterFlushConfig.html
new file mode 100644
index 0000000..f835935
--- /dev/null
+++ b/site/javadoc/lastest/quarks/connectors/file/FileWriterFlushConfig.html
@@ -0,0 +1,443 @@
+<!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_71) on Tue May 17 00:28:45 UTC 2016 -->
+<title>FileWriterFlushConfig (Quarks v0.4.0)</title>
+<meta name="date" content="2016-05-17">
+<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="FileWriterFlushConfig (Quarks v0.4.0)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":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/FileWriterFlushConfig.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="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="class in quarks.connectors.file"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?quarks/connectors/file/FileWriterFlushConfig.html" target="_top">Frames</a></li>
+<li><a href="FileWriterFlushConfig.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">quarks.connectors.file</div>
+<h2 title="Class FileWriterFlushConfig" class="title">Class FileWriterFlushConfig<T></h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>quarks.connectors.file.FileWriterFlushConfig<T></li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt><span class="paramLabel">Type Parameters:</span></dt>
+<dd><code>T</code> - stream tuple type</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">FileWriterFlushConfig<T></span>
+extends java.lang.Object</pre>
+<div class="block">FileWriter active file flush configuration control.
+ <p>
+ Flushing of the active file can be any combination of:
+ <ul>
+ <li>after every <code>cntTuple</code> tuples written</li>
+ <li>after <code>tuplePredicate</code> returns true</li>
+ <li>after <code>periodMsec</code> has elapsed since the last time based flush</li>
+ </ul>
+ If nothing specific is specified, the underlying buffered
+ writer's automatic flushing is utilized.</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="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>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#evaluate-int-T-">evaluate</a></span>(int nTuples,
+ <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="type parameter in FileWriterFlushConfig">T</a> tuple)</code>
+<div class="block">Evaluate if the specified values indicate that a flush should be
+ performed.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#getCntTuples--">getCntTuples</a></span>()</code>
+<div class="block">Get the tuple count configuration value.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#getPeriodMsec--">getPeriodMsec</a></span>()</code>
+<div class="block">Get the time period configuration value.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code><a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><<a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="type parameter in FileWriterFlushConfig">T</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#getTuplePredicate--">getTuplePredicate</a></span>()</code>
+<div class="block">Get the tuple predicate configuration value.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#newConfig-int-long-quarks.function.Predicate-">newConfig</a></span>(int cntTuples,
+ long periodMsec,
+ <a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</code>
+<div class="block">Create a new configuration.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#newCountBasedConfig-int-">newCountBasedConfig</a></span>(int cntTuples)</code>
+<div class="block">same as <code>newConfig(cntTuples, 0, null)</code></div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#newImplicitConfig--">newImplicitConfig</a></span>()</code>
+<div class="block">Create a new configuration.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#newPredicateBasedConfig-quarks.function.Predicate-">newPredicateBasedConfig</a></span>(<a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</code>
+<div class="block">same as <code>newConfig(0, 0, tuplePredicate)</code></div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html#newTimeBasedConfig-long-">newTimeBasedConfig</a></span>(long periodMsec)</code>
+<div class="block">same as <code>newConfig(0, periodMsec, null)</code></div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterFlushConfig.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.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="newImplicitConfig--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newImplicitConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T> newImplicitConfig()</pre>
+<div class="block">Create a new configuration.
+ <p>
+ The underlying buffered writer's automatic flushing is used.
+ <p>
+ Same as <code>newConfig(0, 0, null)</code></div>
+</li>
+</ul>
+<a name="newCountBasedConfig-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newCountBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T> newCountBasedConfig(int cntTuples)</pre>
+<div class="block">same as <code>newConfig(cntTuples, 0, null)</code></div>
+</li>
+</ul>
+<a name="newTimeBasedConfig-long-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newTimeBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T> newTimeBasedConfig(long periodMsec)</pre>
+<div class="block">same as <code>newConfig(0, periodMsec, null)</code></div>
+</li>
+</ul>
+<a name="newPredicateBasedConfig-quarks.function.Predicate-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newPredicateBasedConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T> newPredicateBasedConfig(<a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</pre>
+<div class="block">same as <code>newConfig(0, 0, tuplePredicate)</code></div>
+</li>
+</ul>
+<a name="newConfig-int-long-quarks.function.Predicate-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newConfig</h4>
+<pre>public static <T> <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><T> newConfig(int cntTuples,
+ long periodMsec,
+ <a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><T> tuplePredicate)</pre>
+<div class="block">Create a new configuration.
+ <p>
+ If nothing specific is specified, the underlying buffered
+ writer's automatic flushing is utilized.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>cntTuples</code> - flush every <code>cntTuple</code> tuples written. 0 to disable.</dd>
+<dd><code>periodMsec</code> - flush every <code>periodMsec</code> milliseconds. 0 to disable.</dd>
+<dd><code>tuplePredicate</code> - flush if <code>tuplePredicate</code> is true. null to disable.</dd>
+</dl>
+</li>
+</ul>
+<a name="getCntTuples--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCntTuples</h4>
+<pre>public int getCntTuples()</pre>
+<div class="block">Get the tuple count configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="getPeriodMsec--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPeriodMsec</h4>
+<pre>public long getPeriodMsec()</pre>
+<div class="block">Get the time period configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="getTuplePredicate--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTuplePredicate</h4>
+<pre>public <a href="../../../quarks/function/Predicate.html" title="interface in quarks.function">Predicate</a><<a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="type parameter in FileWriterFlushConfig">T</a>> getTuplePredicate()</pre>
+<div class="block">Get the tuple predicate configuration value.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value</dd>
+</dl>
+</li>
+</ul>
+<a name="evaluate-int-java.lang.Object-">
+<!-- -->
+</a><a name="evaluate-int-T-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>evaluate</h4>
+<pre>public boolean evaluate(int nTuples,
+ <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="type parameter in FileWriterFlushConfig">T</a> tuple)</pre>
+<div class="block">Evaluate if the specified values indicate that a flush should be
+ performed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>nTuples</code> - number of tuples written to the active file</dd>
+<dd><code>tuple</code> - the tuple written to the file</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if a flush should be performed.</dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public java.lang.String toString()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toString</code> in class <code>java.lang.Object</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/FileWriterFlushConfig.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 class="aboutLanguage"><a href="http://quarks.incubator.apache.org">Apache Quarks (incubating)</a></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="class in quarks.connectors.file"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?quarks/connectors/file/FileWriterFlushConfig.html" target="_top">Frames</a></li>
+<li><a href="FileWriterFlushConfig.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 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/9f47ca2f/site/javadoc/lastest/quarks/connectors/file/FileWriterPolicy.html
----------------------------------------------------------------------
diff --git a/site/javadoc/lastest/quarks/connectors/file/FileWriterPolicy.html b/site/javadoc/lastest/quarks/connectors/file/FileWriterPolicy.html
new file mode 100644
index 0000000..da9b783
--- /dev/null
+++ b/site/javadoc/lastest/quarks/connectors/file/FileWriterPolicy.html
@@ -0,0 +1,750 @@
+<!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_71) on Tue May 17 00:28:45 UTC 2016 -->
+<title>FileWriterPolicy (Quarks v0.4.0)</title>
+<meta name="date" content="2016-05-17">
+<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="FileWriterPolicy (Quarks v0.4.0)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"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"],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/FileWriterPolicy.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="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?quarks/connectors/file/FileWriterPolicy.html" target="_top">Frames</a></li>
+<li><a href="FileWriterPolicy.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><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">quarks.connectors.file</div>
+<h2 title="Class FileWriterPolicy" class="title">Class FileWriterPolicy<T></h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>quarks.connectors.file.FileWriterPolicy<T></li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt><span class="paramLabel">Type Parameters:</span></dt>
+<dd><code>T</code> - stream tuple type</dd>
+</dl>
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>quarks.connectors.file.runtime.IFileWriterPolicy<T></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">FileWriterPolicy<T></span>
+extends java.lang.Object
+implements quarks.connectors.file.runtime.IFileWriterPolicy<T></pre>
+<div class="block">A full featured <code>IFileWriterPolicy</code> implementation.
+ <p>
+ The policy implements strategies for:
+ <ul>
+ <li>Active and final file pathname control.</li>
+ <li>Active file flush control (via @{link FileWriterFlushControl})</li>
+ <li>Active file cycle control (when to close/finalize the current active file;
+ via @{link FileWriterCycleControl})</li>
+ <li>file retention control (via @{link FileWriterRetentionControl})</li>
+ </ul>
+ The policy is very configurable. If additional flexibility is required
+ the class can be extended and documented "hook" methods overridden,
+ or an alternative full implementation of <code>FileWriterPolicy</code> can be
+ created.
+ <p>
+ Sample use:
+ <pre>
+ FileWriterPolicy<String> policy = new FileWriterPolicy(
+ FileWriterFlushConfig.newImplicitConfig(),
+ FileWriterCycleConfig.newCountBasedConfig(1000),
+ FileWriterRetentionConfig.newCountBasedConfig(10));
+ String basePathname = "/some/directory/and_base_name";
+
+ TStream<String> streamToWrite = ...
+ FileStreams.textFileWriter(streamToWrite, () -> basePathname, () -> policy)
+ </pre></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file"><code>FileWriterFlushConfig</code></a>,
+<a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file"><code>FileWriterCycleConfig</code></a>,
+<a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file"><code>FileWriterRetentionConfig</code></a></dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#FileWriterPolicy--">FileWriterPolicy</a></span>()</code>
+<div class="block">Create a new file writer policy instance.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#FileWriterPolicy-quarks.connectors.file.FileWriterFlushConfig-quarks.connectors.file.FileWriterCycleConfig-quarks.connectors.file.FileWriterRetentionConfig-">FileWriterPolicy</a></span>(<a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> flushConfig,
+ <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> cycleConfig,
+ <a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file">FileWriterRetentionConfig</a> retentionConfig)</code>
+<div class="block">Create a new file writer policy instance.</div>
+</td>
+</tr>
+</table>
+</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="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="../../../quarks/connectors/file/FileWriterPolicy.html#close--">close</a></span>()</code>
+<div class="block">Release any resources utilized by this policy.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>java.nio.file.Path</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#closeActiveFile-java.nio.file.Path-">closeActiveFile</a></span>(java.nio.file.Path path)</code>
+<div class="block">Close the active file <code>path</code>.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#getCycleConfig--">getCycleConfig</a></span>()</code>
+<div class="block">Get the policy's active file cycle configuration</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#getFlushConfig--">getFlushConfig</a></span>()</code>
+<div class="block">Get the policy's active file flush configuration</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>java.nio.file.Path</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#getNextActiveFilePath--">getNextActiveFilePath</a></span>()</code>
+<div class="block">Return the path for the next active file to write to.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file">FileWriterRetentionConfig</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#getRetentionConfig--">getRetentionConfig</a></span>()</code>
+<div class="block">Get the policy's retention configuration</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>protected java.nio.file.Path</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#hookGenerateFinalFilePath-java.nio.file.Path-">hookGenerateFinalFilePath</a></span>(java.nio.file.Path path)</code>
+<div class="block">Generate the final file path for the active file.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>protected java.nio.file.Path</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#hookGenerateNextActiveFilePath--">hookGenerateNextActiveFilePath</a></span>()</code>
+<div class="block">Generate the path for the next active file.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#hookRenameFile-java.nio.file.Path-java.nio.file.Path-">hookRenameFile</a></span>(java.nio.file.Path activePath,
+ java.nio.file.Path finalPath)</code>
+<div class="block">"Rename" the active file to the final path.</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#initialize-java.lang.String-java.io.Flushable-java.io.Closeable-">initialize</a></span>(java.lang.String basePathname,
+ java.io.Flushable flushable,
+ java.io.Closeable closeable)</code>
+<div class="block">Initialize the policy with the base pathname of files to generate
+ and objects that can be
+ called to perform timer based flush or close (cycle) of the active file.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#shouldCycle--">shouldCycle</a></span>()</code>
+<div class="block">Answers the question "should the active file be cycled?".</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#shouldFlush--">shouldFlush</a></span>()</code>
+<div class="block">Answers the question "should the active file be flushed?".</div>
+</td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#toString--">toString</a></span>()</code> </td>
+</tr>
+<tr id="i13" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/file/FileWriterPolicy.html#wrote-T-long-">wrote</a></span>(<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a> tuple,
+ long nbytes)</code>
+<div class="block">Inform the policy of every tuple written to the active file.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="FileWriterPolicy--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FileWriterPolicy</h4>
+<pre>public FileWriterPolicy()</pre>
+<div class="block">Create a new file writer policy instance.
+ <p>
+ The configuration is:
+ <ul>
+ <li>10 second time based active file flushing</li>
+ <li>1MB file size based active file cycling</li>
+ <li>10 file retention count</li>
+ </ul>
+ The active and final file pathname behavior is specified in
+ <a href="../../../quarks/connectors/file/FileWriterPolicy.html#FileWriterPolicy-quarks.connectors.file.FileWriterFlushConfig-quarks.connectors.file.FileWriterCycleConfig-quarks.connectors.file.FileWriterRetentionConfig-"><code>FileWriterPolicy(FileWriterFlushConfig, FileWriterCycleConfig, FileWriterRetentionConfig)</code></a></div>
+</li>
+</ul>
+<a name="FileWriterPolicy-quarks.connectors.file.FileWriterFlushConfig-quarks.connectors.file.FileWriterCycleConfig-quarks.connectors.file.FileWriterRetentionConfig-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>FileWriterPolicy</h4>
+<pre>public FileWriterPolicy(<a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> flushConfig,
+ <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> cycleConfig,
+ <a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file">FileWriterRetentionConfig</a> retentionConfig)</pre>
+<div class="block">Create a new file writer policy instance.
+ <p>
+ <code>flushConfig</code>, <code>cycleConfig</code> and <code>retentionConfig</code>
+ specify the configuration of the various controls.
+ <p>
+ The active file and final file pathnames are based
+ on the <code>basePathname</code> received in
+ <a href="../../../quarks/connectors/file/FileWriterPolicy.html#initialize-java.lang.String-java.io.Flushable-java.io.Closeable-"><code>initialize(String, Flushable, Closeable)</code></a>.
+ <p>
+ Where <code>parent</code> and <code>baseLeafname</code> are the
+ parent path and file name respectively of <code>basePathname</code>:
+ <ul>
+ <li>the active file is <code>parent/.baseLeafname</code>"</li>
+ <li>final file names are <code>parent/baseLeafname_YYYYMMDD_HHMMSS[_<n>]</code>
+ where the optional <code>_<n></code> suffix is only present if needed
+ to distinguish a file from the previously finalized file.
+ <code><n></code> starts at 1 and is monotonically incremented.
+ </li>
+ </ul></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>flushConfig</code> - active file flush control configuration</dd>
+<dd><code>cycleConfig</code> - active file cycle control configuration</dd>
+<dd><code>retentionConfig</code> - final file retention control configuration</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="close--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>close</h4>
+<pre>public void close()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Release any resources utilized by this policy.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>close</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="getFlushConfig--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getFlushConfig</h4>
+<pre>public <a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file">FileWriterFlushConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> getFlushConfig()</pre>
+<div class="block">Get the policy's active file flush configuration</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the flush configuration</dd>
+</dl>
+</li>
+</ul>
+<a name="getCycleConfig--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCycleConfig</h4>
+<pre>public <a href="../../../quarks/connectors/file/FileWriterCycleConfig.html" title="class in quarks.connectors.file">FileWriterCycleConfig</a><<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> getCycleConfig()</pre>
+<div class="block">Get the policy's active file cycle configuration</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the cycle configuration</dd>
+</dl>
+</li>
+</ul>
+<a name="getRetentionConfig--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRetentionConfig</h4>
+<pre>public <a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file">FileWriterRetentionConfig</a> getRetentionConfig()</pre>
+<div class="block">Get the policy's retention configuration</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the retention configuration</dd>
+</dl>
+</li>
+</ul>
+<a name="initialize-java.lang.String-java.io.Flushable-java.io.Closeable-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>initialize</h4>
+<pre>public void initialize(java.lang.String basePathname,
+ java.io.Flushable flushable,
+ java.io.Closeable closeable)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Initialize the policy with the base pathname of files to generate
+ and objects that can be
+ called to perform timer based flush or close (cycle) of the active file.
+ <p>
+ Cycling involves finalizing the active file (getting it to its
+ final destination / pathname) and applying any retention policy.
+ <p>
+ The supplied <code>closeable</code> must close the active file's output stream
+ and then call <code>IFileWriterPolicy.closeActiveFile(Path)</code>.
+ <p>
+ For non-timer based strategies, the file writer generally triggers
+ flush and cycle processing
+ following a tuple write as informed by <code>IFileWriterPolicy.shouldCycle()</code> and
+ <code>IFileWriterPolicy.shouldFlush()</code>.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>initialize</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>basePathname</code> - the directory and base leafname for final files</dd>
+</dl>
+</li>
+</ul>
+<a name="wrote-java.lang.Object-long-">
+<!-- -->
+</a><a name="wrote-T-long-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>wrote</h4>
+<pre>public void wrote(<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a> tuple,
+ long nbytes)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Inform the policy of every tuple written to the active file.
+ <p>
+ The policy can use this to update its state so that it
+ can answer the questions <code>IFileWriterPolicy.shouldFlush()</code>
+ and <code>IFileWriterPolicy.shouldCycle()</code> for count, size, or
+ tuple attribute based policies.
+ <p>
+ The policy can also use this to update its state
+ for implementing time based flush and cycle policies.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>wrote</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>tuple</code> - the tuple written</dd>
+<dd><code>nbytes</code> - the number of bytes written</dd>
+</dl>
+</li>
+</ul>
+<a name="shouldFlush--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>shouldFlush</h4>
+<pre>public boolean shouldFlush()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Answers the question "should the active file be flushed?".
+ <p>
+ The state is reset to false after this returns.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>shouldFlush</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the active file should be flushed</dd>
+</dl>
+</li>
+</ul>
+<a name="shouldCycle--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>shouldCycle</h4>
+<pre>public boolean shouldCycle()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Answers the question "should the active file be cycled?".
+ <p>
+ The state is reset to false after this returns.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>shouldCycle</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the active file should be cycled</dd>
+</dl>
+</li>
+</ul>
+<a name="getNextActiveFilePath--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNextActiveFilePath</h4>
+<pre>public java.nio.file.Path getNextActiveFilePath()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Return the path for the next active file to write to.
+ <p>
+ If there was a current active file, <code>IFileWriterPolicy.closeActiveFile(Path)</code>
+ must be called prior to this.
+ <p>
+ The leafname must be a hidden file (<code>java.io.File.isHidden()==true</code>
+ to be compatible with a directory watcher
+ <a href="../../../quarks/connectors/file/FileStreams.html#directoryWatcher-quarks.topology.TopologyElement-quarks.function.Supplier-"><code>FileStreams.directoryWatcher(quarks.topology.TopologyElement, quarks.function.Supplier)</code></a></div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>getNextActiveFilePath</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>path for the active file</dd>
+</dl>
+</li>
+</ul>
+<a name="closeActiveFile-java.nio.file.Path-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>closeActiveFile</h4>
+<pre>public java.nio.file.Path closeActiveFile(java.nio.file.Path path)
+ throws java.io.IOException</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code>quarks.connectors.file.runtime.IFileWriterPolicy</code></span></div>
+<div class="block">Close the active file <code>path</code>.
+ <p>
+ Generate the final path for the active file and
+ rename/move/copy it as necessary to be at that final path.
+ <p>
+ Apply the retention policy.
+ <p>
+ The active file's writer iostream must be closed prior to calling this.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code>closeActiveFile</code> in interface <code>quarks.connectors.file.runtime.IFileWriterPolicy<<a href="../../../quarks/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>path</code> - the active file (from <code>IFileWriterPolicy.getNextActiveFilePath()</code>).</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the final path</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd>
+</dl>
+</li>
+</ul>
+<a name="hookGenerateFinalFilePath-java.nio.file.Path-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hookGenerateFinalFilePath</h4>
+<pre>protected java.nio.file.Path hookGenerateFinalFilePath(java.nio.file.Path path)</pre>
+<div class="block">Generate the final file path for the active file.
+ <p>
+ The default implementation yields:
+ <br>
+ final file names are <code>basePathname_YYYYMMDD_HHMMSS[_<n>]</code>
+ where the optional <code>_<n></code> suffix is only present if needed
+ to distinguish a file from the previously finalized file.
+ <code><n></code> starts at 1 and is monitonically incremented.
+ <p>
+ This hook method can be overridden.
+ <p>
+ Note, the implementation must handle the unlikely, but happens
+ in tests, case where files are cycling very fast (multiple per sec)
+ and the retention config tosses some within that same second.
+ I.e., avoid generating final path sequences like:
+ <pre>
+ leaf_YYYYMMDD_103099
+ leaf_YYYYMMDD_103099_1
+ leaf_YYYYMMDD_103099_2
+ delete leaf_YYYYMMDD_103099 -- retention cnt was 2
+ leaf_YYYYMMDD_103099 // should be _3
+ </pre></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>path</code> - the active file path to finalize</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>final path for the file</dd>
+</dl>
+</li>
+</ul>
+<a name="hookGenerateNextActiveFilePath--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hookGenerateNextActiveFilePath</h4>
+<pre>protected java.nio.file.Path hookGenerateNextActiveFilePath()</pre>
+<div class="block">Generate the path for the next active file.
+ <p>
+ The default implementation yields <code>parent/.baseLeafname</code>
+ from <code>basePathname</code>.
+ <p>
+ This hook method can be overridden.
+ <p>
+ See <code>IFileWriterPolicy.getNextActiveFilePath()</code> regarding
+ constraints.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>path to use for the next active file.</dd>
+</dl>
+</li>
+</ul>
+<a name="hookRenameFile-java.nio.file.Path-java.nio.file.Path-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hookRenameFile</h4>
+<pre>protected void hookRenameFile(java.nio.file.Path activePath,
+ java.nio.file.Path finalPath)
+ throws java.io.IOException</pre>
+<div class="block">"Rename" the active file to the final path.
+ <p>
+ The default implementation uses <code>java.io.File.renameTo()</code>
+ and works for the default <a href="../../../quarks/connectors/file/FileWriterPolicy.html#hookGenerateNextActiveFilePath--"><code>hookGenerateNextActiveFilePath()</code></a>
+ and <a href="../../../quarks/connectors/file/FileWriterPolicy.html#hookGenerateFinalFilePath-java.nio.file.Path-"><code>hookGenerateFinalFilePath(Path path)</code></a> implementations.
+ <p>
+ This hook method can be overridden.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>activePath</code> - path of the active file</dd>
+<dd><code>finalPath</code> - path to the final destination</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public java.lang.String toString()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toString</code> in class <code>java.lang.Object</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/FileWriterPolicy.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 class="aboutLanguage"><a href="http://quarks.incubator.apache.org">Apache Quarks (incubating)</a></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../quarks/connectors/file/FileWriterFlushConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../quarks/connectors/file/FileWriterRetentionConfig.html" title="class in quarks.connectors.file"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?quarks/connectors/file/FileWriterPolicy.html" target="_top">Frames</a></li>
+<li><a href="FileWriterPolicy.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><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p>
+</body>
+</html>