http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterPolicy.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterPolicy.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterPolicy.html new file mode 100644 index 0000000..2ba1da0 --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterPolicy.html @@ -0,0 +1,756 @@ +<!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_92) on Tue Jul 26 12:40:38 PDT 2016 --> +<title>FileWriterPolicy (Edgent v0.4.0)</title> +<meta name="date" content="2016-07-26"> +<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 (Edgent 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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/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">org.apache.edgent.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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<T></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/edgent/connectors/file/CompressedFileWriterPolicy.html" title="class in org.apache.edgent.connectors.file">CompressedFileWriterPolicy</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FileWriterPolicy<T></span> +extends java.lang.Object +implements org.apache.edgent.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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file"><code>FileWriterFlushConfig</code></a>, +<a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file"><code>FileWriterCycleConfig</code></a>, +<a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html#FileWriterPolicy-org.apache.edgent.connectors.file.FileWriterFlushConfig-org.apache.edgent.connectors.file.FileWriterCycleConfig-org.apache.edgent.connectors.file.FileWriterRetentionConfig-">FileWriterPolicy</a></span>(<a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> flushConfig, + <a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> cycleConfig, + <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html#wrote-T-long-">wrote</a></span>(<a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html#FileWriterPolicy-org.apache.edgent.connectors.file.FileWriterFlushConfig-org.apache.edgent.connectors.file.FileWriterCycleConfig-org.apache.edgent.connectors.file.FileWriterRetentionConfig-"><code>FileWriterPolicy(FileWriterFlushConfig, FileWriterCycleConfig, FileWriterRetentionConfig)</code></a></div> +</li> +</ul> +<a name="FileWriterPolicy-org.apache.edgent.connectors.file.FileWriterFlushConfig-org.apache.edgent.connectors.file.FileWriterCycleConfig-org.apache.edgent.connectors.file.FileWriterRetentionConfig-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileWriterPolicy</h4> +<pre>public FileWriterPolicy(<a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> flushConfig, + <a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> cycleConfig, + <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.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="../../../../../org/apache/edgent/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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><<a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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> +<dd><code>flushable</code> - function to perform the flush</dd> +<dd><code>closeable</code> - function to perform the close</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="../../../../../org/apache/edgent/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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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>org.apache.edgent.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="../../../../../org/apache/edgent/connectors/file/FileStreams.html#directoryWatcher-org.apache.edgent.topology.TopologyElement-org.apache.edgent.function.Supplier-"><code>FileStreams.directoryWatcher(org.apache.edgent.topology.TopologyElement, org.apache.edgent.function.Supplier)</code></a></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>getNextActiveFilePath</code> in interface <code>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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>org.apache.edgent.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>org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<<a href="../../../../../org/apache/edgent/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> - on failure</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="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html#hookGenerateNextActiveFilePath--"><code>hookGenerateNextActiveFilePath()</code></a> + and <a href="../../../../../org/apache/edgent/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> - on failure</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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/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 - 54ea8ac-20160726-1240</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterRetentionConfig.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterRetentionConfig.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterRetentionConfig.html new file mode 100644 index 0000000..de27333 --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterRetentionConfig.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_92) on Tue Jul 26 12:40:38 PDT 2016 --> +<title>FileWriterRetentionConfig (Edgent v0.4.0)</title> +<meta name="date" content="2016-07-26"> +<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="FileWriterRetentionConfig (Edgent 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":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/FileWriterRetentionConfig.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/edgent/connectors/file/FileWriterPolicy.html" title="class in org.apache.edgent.connectors.file"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" target="_top">Frames</a></li> +<li><a href="FileWriterRetentionConfig.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.edgent.connectors.file</div> +<h2 title="Class FileWriterRetentionConfig" class="title">Class FileWriterRetentionConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.connectors.file.FileWriterRetentionConfig</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FileWriterRetentionConfig</span> +extends java.lang.Object</pre> +<div class="block">FileWriter finalized (non-active) file retention configuration control. + <p> + File removal can be any combination of: + <ul> + <li>remove a file when <code>fileCount</code> would be exceeded</li> + <li>remove a file when <code>aggregateFileSize</code> would be exceeded</li> + <li>remove a file that's older than <code>ageSec</code> seconds</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="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#evaluate-int-long-">evaluate</a></span>(int fileCount, + long aggregateFileSize)</code> +<div class="block">Evaluate if the specified values indicate that a final file should + be removed.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#getAgeSec--">getAgeSec</a></span>()</code> +<div class="block">Get the file age 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="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#getAggregateFileSize--">getAggregateFileSize</a></span>()</code> +<div class="block">Get the aggregate file size configuration value.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#getFileCount--">getFileCount</a></span>()</code> +<div class="block">Get the file count configuration value.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#getPeriodMsec--">getPeriodMsec</a></span>()</code> +<div class="block">Get the time period configuration value.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#newAgeBasedConfig-long-long-">newAgeBasedConfig</a></span>(long ageSec, + long periodMsec)</code> +<div class="block">same as <code>newConfig(0, 0, ageSe, periodMsecc)</code></div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#newAggregateFileSizeBasedConfig-long-">newAggregateFileSizeBasedConfig</a></span>(long aggregateFileSize)</code> +<div class="block">same as <code>newConfig(0, aggregateFileSize, 0, 0)</code></div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#newConfig-int-long-long-long-">newConfig</a></span>(int fileCount, + long aggregateFileSize, + long ageSec, + long periodMsec)</code> +<div class="block">Create a new configuration.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html#newFileCountBasedConfig-int-">newFileCountBasedConfig</a></span>(int fileCount)</code> +<div class="block">same as <code>newConfig(fileCount, 0, 0, 0)</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="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.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="newFileCountBasedConfig-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newFileCountBasedConfig</h4> +<pre>public static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a> newFileCountBasedConfig(int fileCount)</pre> +<div class="block">same as <code>newConfig(fileCount, 0, 0, 0)</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fileCount</code> - remove a file when <code>fileCount</code> would be exceeded. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the retention config</dd> +</dl> +</li> +</ul> +<a name="newAggregateFileSizeBasedConfig-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newAggregateFileSizeBasedConfig</h4> +<pre>public static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a> newAggregateFileSizeBasedConfig(long aggregateFileSize)</pre> +<div class="block">same as <code>newConfig(0, aggregateFileSize, 0, 0)</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aggregateFileSize</code> - remove a file when <code>aggregateFileSize</code> would be exceeded. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the retention config</dd> +</dl> +</li> +</ul> +<a name="newAgeBasedConfig-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newAgeBasedConfig</h4> +<pre>public static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a> newAgeBasedConfig(long ageSec, + long periodMsec)</pre> +<div class="block">same as <code>newConfig(0, 0, ageSe, periodMsecc)</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ageSec</code> - remove a file that's older than <code>ageSec</code> seconds. 0 to disable.</dd> +<dd><code>periodMsec</code> - frequency for checking for ageSec based removal. 0 to disable.]</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the retention config</dd> +</dl> +</li> +</ul> +<a name="newConfig-int-long-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newConfig</h4> +<pre>public static <a href="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a> newConfig(int fileCount, + long aggregateFileSize, + long ageSec, + long periodMsec)</pre> +<div class="block">Create a new configuration.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fileCount</code> - remove a file when <code>fileCount</code> would be exceeded. 0 to disable.</dd> +<dd><code>aggregateFileSize</code> - remove a file when <code>aggregateFileSize</code> would be exceeded. 0 to disable.</dd> +<dd><code>ageSec</code> - remove a file that's older than <code>ageSec</code> seconds. 0 to disable.</dd> +<dd><code>periodMsec</code> - frequency for checking for ageSec based removal. 0 to disable.]</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the retention config</dd> +</dl> +</li> +</ul> +<a name="getFileCount--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFileCount</h4> +<pre>public int getFileCount()</pre> +<div class="block">Get the file count configuration value.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the value</dd> +</dl> +</li> +</ul> +<a name="getAggregateFileSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAggregateFileSize</h4> +<pre>public long getAggregateFileSize()</pre> +<div class="block">Get the aggregate file size configuration value.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the value</dd> +</dl> +</li> +</ul> +<a name="getAgeSec--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAgeSec</h4> +<pre>public long getAgeSec()</pre> +<div class="block">Get the file age 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="evaluate-int-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public boolean evaluate(int fileCount, + long aggregateFileSize)</pre> +<div class="block">Evaluate if the specified values indicate that a final file should + be removed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fileCount</code> - the current number of retained files</dd> +<dd><code>aggregateFileSize</code> - the aggregate size of all of the retained files</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if a retained file should be removed.</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/FileWriterRetentionConfig.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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="class in org.apache.edgent.connectors.file"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" target="_top">Frames</a></li> +<li><a href="FileWriterRetentionConfig.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 - 54ea8ac-20160726-1240</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/CompressedFileWriterPolicy.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/CompressedFileWriterPolicy.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/CompressedFileWriterPolicy.html new file mode 100644 index 0000000..c72dcba --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/CompressedFileWriterPolicy.html @@ -0,0 +1,126 @@ +<!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_92) on Tue Jul 26 12:40:39 PDT 2016 --> +<title>Uses of Class org.apache.edgent.connectors.file.CompressedFileWriterPolicy (Edgent v0.4.0)</title> +<meta name="date" content="2016-07-26"> +<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="Uses of Class org.apache.edgent.connectors.file.CompressedFileWriterPolicy (Edgent v0.4.0)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../../../org/apache/edgent/connectors/file/CompressedFileWriterPolicy.html" title="class in org.apache.edgent.connectors.file">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/file/class-use/CompressedFileWriterPolicy.html" target="_top">Frames</a></li> +<li><a href="CompressedFileWriterPolicy.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.edgent.connectors.file.CompressedFileWriterPolicy" class="title">Uses of Class<br>org.apache.edgent.connectors.file.CompressedFileWriterPolicy</h2> +</div> +<div class="classUseContainer">No usage of org.apache.edgent.connectors.file.CompressedFileWriterPolicy</div> +<!-- ======= 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><a href="../../../../../../org/apache/edgent/connectors/file/CompressedFileWriterPolicy.html" title="class in org.apache.edgent.connectors.file">Class</a></li> +<li class="navBarCell1Rev">Use</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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/file/class-use/CompressedFileWriterPolicy.html" target="_top">Frames</a></li> +<li><a href="CompressedFileWriterPolicy.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 54ea8ac-20160726-1240</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileStreams.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileStreams.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileStreams.html new file mode 100644 index 0000000..df3a5de --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileStreams.html @@ -0,0 +1,126 @@ +<!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_92) on Tue Jul 26 12:40:39 PDT 2016 --> +<title>Uses of Class org.apache.edgent.connectors.file.FileStreams (Edgent v0.4.0)</title> +<meta name="date" content="2016-07-26"> +<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="Uses of Class org.apache.edgent.connectors.file.FileStreams (Edgent v0.4.0)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../../../org/apache/edgent/connectors/file/FileStreams.html" title="class in org.apache.edgent.connectors.file">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/file/class-use/FileStreams.html" target="_top">Frames</a></li> +<li><a href="FileStreams.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.edgent.connectors.file.FileStreams" class="title">Uses of Class<br>org.apache.edgent.connectors.file.FileStreams</h2> +</div> +<div class="classUseContainer">No usage of org.apache.edgent.connectors.file.FileStreams</div> +<!-- ======= 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><a href="../../../../../../org/apache/edgent/connectors/file/FileStreams.html" title="class in org.apache.edgent.connectors.file">Class</a></li> +<li class="navBarCell1Rev">Use</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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/file/class-use/FileStreams.html" target="_top">Frames</a></li> +<li><a href="FileStreams.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 54ea8ac-20160726-1240</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileWriterCycleConfig.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileWriterCycleConfig.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileWriterCycleConfig.html new file mode 100644 index 0000000..0a1401b --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/class-use/FileWriterCycleConfig.html @@ -0,0 +1,223 @@ +<!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_92) on Tue Jul 26 12:40:39 PDT 2016 --> +<title>Uses of Class org.apache.edgent.connectors.file.FileWriterCycleConfig (Edgent v0.4.0)</title> +<meta name="date" content="2016-07-26"> +<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="Uses of Class org.apache.edgent.connectors.file.FileWriterCycleConfig (Edgent v0.4.0)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/file/class-use/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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.edgent.connectors.file.FileWriterCycleConfig" class="title">Uses of Class<br>org.apache.edgent.connectors.file.FileWriterCycleConfig</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.connectors.file">org.apache.edgent.connectors.file</a></td> +<td class="colLast"> +<div class="block">File stream connector.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.edgent.connectors.file"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a> in <a href="../../../../../../org/apache/edgent/connectors/file/package-summary.html">org.apache.edgent.connectors.file</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/edgent/connectors/file/package-summary.html">org.apache.edgent.connectors.file</a> that return <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>></code></td> +<td class="colLast"><span class="typeNameLabel">FileWriterPolicy.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html#getCycleConfig--">getCycleConfig</a></span>()</code> +<div class="block">Get the policy's active file cycle configuration</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T></code></td> +<td class="colLast"><span class="typeNameLabel">FileWriterCycleConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html#newConfig-long-int-long-org.apache.edgent.function.Predicate-">newConfig</a></span>(long fileSize, + int cntTuples, + long periodMsec, + <a href="../../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T> tuplePredicate)</code> +<div class="block">Create a new configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T></code></td> +<td class="colLast"><span class="typeNameLabel">FileWriterCycleConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html#newCountBasedConfig-int-">newCountBasedConfig</a></span>(int cntTuples)</code> +<div class="block">same as <code>newConfig(0, cntTuples, 0, null)</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T></code></td> +<td class="colLast"><span class="typeNameLabel">FileWriterCycleConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/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 class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T></code></td> +<td class="colLast"><span class="typeNameLabel">FileWriterCycleConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html#newPredicateBasedConfig-org.apache.edgent.function.Predicate-">newPredicateBasedConfig</a></span>(<a href="../../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T> tuplePredicate)</code> +<div class="block">same as <code>newConfig(0, 0, 0, tuplePredicate)</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T></code></td> +<td class="colLast"><span class="typeNameLabel">FileWriterCycleConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/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> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../../org/apache/edgent/connectors/file/package-summary.html">org.apache.edgent.connectors.file</a> with parameters of type <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/file/CompressedFileWriterPolicy.html#CompressedFileWriterPolicy-org.apache.edgent.connectors.file.FileWriterFlushConfig-org.apache.edgent.connectors.file.FileWriterCycleConfig-org.apache.edgent.connectors.file.FileWriterRetentionConfig-">CompressedFileWriterPolicy</a></span>(<a href="../../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><<a href="../../../../../../org/apache/edgent/connectors/file/CompressedFileWriterPolicy.html" title="type parameter in CompressedFileWriterPolicy">T</a>> flushConfig, + <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../../org/apache/edgent/connectors/file/CompressedFileWriterPolicy.html" title="type parameter in CompressedFileWriterPolicy">T</a>> cycleConfig, + <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a> retentionConfig)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html#FileWriterPolicy-org.apache.edgent.connectors.file.FileWriterFlushConfig-org.apache.edgent.connectors.file.FileWriterCycleConfig-org.apache.edgent.connectors.file.FileWriterRetentionConfig-">FileWriterPolicy</a></span>(<a href="../../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><<a href="../../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> flushConfig, + <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><<a href="../../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="type parameter in FileWriterPolicy">T</a>> cycleConfig, + <a href="../../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterRetentionConfig</a> retentionConfig)</code> +<div class="block">Create a new file writer policy instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">Class</a></li> +<li class="navBarCell1Rev">Use</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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/file/class-use/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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 54ea8ac-20160726-1240</small></p> +</body> +</html>
