http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileStreams.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileStreams.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileStreams.html new file mode 100644 index 0000000..a39db0f --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileStreams.html @@ -0,0 +1,518 @@ +<!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>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="FileStreams (Edgent v0.4.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/FileStreams.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/CompressedFileWriterPolicy.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/FileWriterCycleConfig.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/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> +<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 FileStreams" class="title">Class FileStreams</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.connectors.file.FileStreams</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FileStreams</span> +extends java.lang.Object</pre> +<div class="block"><code>FileStreams</code> is a connector for integrating with file system objects. + <p> + File stream operations include: + <ul> + <li>Write tuples to text files - <a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#textFileWriter-org.apache.edgent.topology.TStream-org.apache.edgent.function.Supplier-org.apache.edgent.function.Supplier-"><code>textFileWriter</code></a></li> + <li>Watch a directory for new files - <a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#directoryWatcher-org.apache.edgent.topology.TopologyElement-org.apache.edgent.function.Supplier-"><code>directoryWatcher</code></a></li> + <li>Create tuples from text files - <a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#textFileReader-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.BiFunction-"><code>textFileReader</code></a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#directoryWatcher-org.apache.edgent.topology.TopologyElement-org.apache.edgent.function.Supplier-">directoryWatcher</a></span>(<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a> te, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> directory)</code> +<div class="block">Declare a stream containing the absolute pathname of + newly created file names from watching <code>directory</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#directoryWatcher-org.apache.edgent.topology.TopologyElement-org.apache.edgent.function.Supplier-java.util.Comparator-">directoryWatcher</a></span>(<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a> te, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> directory, + java.util.Comparator<java.io.File> comparator)</code> +<div class="block">Declare a stream containing the absolute pathname of + newly created file names from watching <code>directory</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#textFileReader-org.apache.edgent.topology.TStream-">textFileReader</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> pathnames)</code> +<div class="block">Declare a stream containing the lines read from the files + whose pathnames correspond to each tuple on the <code>pathnames</code> + stream.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#textFileReader-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.BiFunction-">textFileReader</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> pathnames, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><java.lang.String,java.lang.String> preFn, + <a href="../../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><java.lang.String,java.lang.Exception,java.lang.String> postFn)</code> +<div class="block">Declare a stream containing the lines read from the files + whose pathnames correspond to each tuple on the <code>pathnames</code> + stream.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#textFileWriter-org.apache.edgent.topology.TStream-org.apache.edgent.function.Supplier-">textFileWriter</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> contents, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> basePathname)</code> +<div class="block">Write the contents of a stream to files.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.html#textFileWriter-org.apache.edgent.topology.TStream-org.apache.edgent.function.Supplier-org.apache.edgent.function.Supplier-">textFileWriter</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> contents, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> basePathname, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<java.lang.String>> policy)</code> +<div class="block">Write the contents of a stream to files subject to the control + of a file writer policy.</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, toString, 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="directoryWatcher-org.apache.edgent.topology.TopologyElement-org.apache.edgent.function.Supplier-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>directoryWatcher</h4> +<pre>public static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> directoryWatcher(<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a> te, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> directory)</pre> +<div class="block">Declare a stream containing the absolute pathname of + newly created file names from watching <code>directory</code>. + <p> + This is the same as <code>directoryWatcher(t, () -> dir, null)</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>te</code> - topology element whose topology the watcher will be added to</dd> +<dd><code>directory</code> - Name of the directory to watch.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing absolute pathnames of newly created files in + <code>directory</code>.</dd> +</dl> +</li> +</ul> +<a name="directoryWatcher-org.apache.edgent.topology.TopologyElement-org.apache.edgent.function.Supplier-java.util.Comparator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>directoryWatcher</h4> +<pre>public static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> directoryWatcher(<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a> te, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> directory, + java.util.Comparator<java.io.File> comparator)</pre> +<div class="block">Declare a stream containing the absolute pathname of + newly created file names from watching <code>directory</code>. + <p> + Hidden files (java.io.File.isHidden()==true) are ignored. + This is compatible with <code>textFileWriter</code>. + <p> + Sample use: + <pre><code> + String dir = "/some/directory/path"; + Topology t = ... + TStream<String> pathnames = FileStreams.directoryWatcher(t, () -> dir, null); + </code></pre> + <p> + The order of the files in the stream is dictated by a <code>Comparator</code>. + The default comparator orders files by <code>File.lastModified()</code> values. + There are no guarantees on the processing order of files that + have the same lastModified value. + Note, lastModified values are subject to filesystem timestamp + quantization - e.g., 1second. + <p> + Note: due to the asynchronous nature of things, if files in the + directory may be removed, the receiver of a tuple with a "new" file + pathname may need to be prepared for the pathname to no longer be + valid when it receives the tuple or during its processing of the tuple. + <p> + The behavior on MacOS may be unsavory, even as recent as Java8, as + MacOs Java lacks a native implementation of <code>WatchService</code>. + The result can be a delay in detecting newly created files (e.g., 10sec) + as well not detecting rapid deletion and recreation of a file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>te</code> - topology element whose topology the watcher will be added to</dd> +<dd><code>directory</code> - Name of the directory to watch.</dd> +<dd><code>comparator</code> - Comparator to use to order newly seen file pathnames. + May be null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing absolute pathnames of newly created files in + <code>directory</code>.</dd> +</dl> +</li> +</ul> +<a name="textFileReader-org.apache.edgent.topology.TStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>textFileReader</h4> +<pre>public static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> textFileReader(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> pathnames)</pre> +<div class="block">Declare a stream containing the lines read from the files + whose pathnames correspond to each tuple on the <code>pathnames</code> + stream. + <p> + This is the same as <code>textFileReader(pathnames, null, null)</code> + <p> + Sample use: + <pre><code> + String dir = "/some/directory/path"; + Topology t = ... + TStream<String> pathnames = FileStreams.directoryWatcher(t, () -> dir); + TStream<String> contents = FileStreams.textFileReader(pathnames); + contents.print(); + </code></pre></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pathnames</code> - Stream containing pathnames of files to read.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing lines from the files.</dd> +</dl> +</li> +</ul> +<a name="textFileReader-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.BiFunction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>textFileReader</h4> +<pre>public static <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> textFileReader(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> pathnames, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><java.lang.String,java.lang.String> preFn, + <a href="../../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><java.lang.String,java.lang.Exception,java.lang.String> postFn)</pre> +<div class="block">Declare a stream containing the lines read from the files + whose pathnames correspond to each tuple on the <code>pathnames</code> + stream. + <p> + All files are assumed to be encoded in UTF-8. The lines are + output in the order they appear in each file, with the first line of + a file appearing first. A file is not subsequently monitored for + additional lines. + <p> + If a file can not be read, e.g., a file doesn't exist at that pathname + or the pathname is for a directory, + an error will be logged. + <p> + Optional <code>preFn</code> and <code>postFn</code> functions may be supplied. + These are called prior to processing a tuple (pathname) and after + respectively. They provide a way to encode markers in the generated + stream. + <p> + Sample use: + <pre><code> + // watch a directory for files, creating a stream with the contents of + // each file. Use a preFn to include a file separator marker in the + // stream. Use a postFn to delete a file once it's been processed. + String dir = "/some/directory/path"; + Topology t = ... + TStream<String> pathnames = FileStreams.directoryWatcher(t, () -> dir); + TStream<String> contents = FileStreams.textFileReader( + pathnames, + path -> { return "###<PATH-MARKER>### " + path }, + (path,exception) -> { new File(path).delete(), return null; } + ); + contents.print(); + </code></pre></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pathnames</code> - Stream containing pathnames of files to read.</dd> +<dd><code>preFn</code> - Pre-visit <code>Function<String,String></code>. + The input is the pathname. + The result, when non-null, is added to the output stream. + The function may be null.</dd> +<dd><code>postFn</code> - Post-visit <code>BiFunction<String,Exception,String></code>. + The input is the pathname and an exception. The exception + is null if there were no errors. + The result, when non-null, is added to the output stream. + The function may be null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing lines from the files.</dd> +</dl> +</li> +</ul> +<a name="textFileWriter-org.apache.edgent.topology.TStream-org.apache.edgent.function.Supplier-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>textFileWriter</h4> +<pre>public static <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String> textFileWriter(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> contents, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> basePathname)</pre> +<div class="block">Write the contents of a stream to files. + <p> + The default <a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="class in org.apache.edgent.connectors.file"><code>FileWriterPolicy</code></a> is used. + <p> + This is the same as <code>textFileWriter(contents, basePathname, null)</code>. + <p> + Sample use: + <pre><code> + // write a stream of LogEvent to files, using the default + // file writer policy + String basePathname = "/myLogDir/LOG"; // yield LOG_YYYYMMDD_HHMMSS + TStream<MyLogEvent> events = ... + TStream<String> stringEvents = events.map(event -> event.toString()); + FileStreams.textFileWriter(stringEvents, () -> basePathname); + </code></pre></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>contents</code> - the lines to write</dd> +<dd><code>basePathname</code> - the base pathname of the created files</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a TSink</dd> +</dl> +</li> +</ul> +<a name="textFileWriter-org.apache.edgent.topology.TStream-org.apache.edgent.function.Supplier-org.apache.edgent.function.Supplier-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>textFileWriter</h4> +<pre>public static <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String> textFileWriter(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> contents, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.String> basePathname, + <a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><org.apache.edgent.connectors.file.runtime.IFileWriterPolicy<java.lang.String>> policy)</pre> +<div class="block">Write the contents of a stream to files subject to the control + of a file writer policy. + <p> + A separate policy instance must be used for invocation. + A default <a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="class in org.apache.edgent.connectors.file"><code>FileWriterPolicy</code></a> is used if a policy is not specified. + <p> + Sample use: + <pre><code> + // write a stream of LogEvent to files using a policy of: + // no additional flush, 100 events per file, retain 5 files + IFileWriterPolicy<String> policy = new FileWriterPolicy<String>( + FileWriterFlushConfig.newImplicitConfig(), + FileWriterCycleConfig.newCountBasedConfig(100), + FileWriterRetentionConfig.newFileCountBasedConfig(5) + ); + String basePathname = "/myLogDir/LOG"; // yield LOG_YYYYMMDD_HHMMSS + TStream<MyLogEvent> events = ... + TStream<String> stringEvents = events.map(event -> event.toString()); + FileStreams.textFileWriter(stringEvents, () -> basePathname, () -> policy); + </code></pre></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>contents</code> - the lines to write</dd> +<dd><code>basePathname</code> - the base pathname of the created files</dd> +<dd><code>policy</code> - the policy to use. may be null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a TSink</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/edgent/connectors/file/FileWriterPolicy.html" title="class in org.apache.edgent.connectors.file"><code>FileWriterPolicy</code></a></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/FileStreams.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/CompressedFileWriterPolicy.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/FileWriterCycleConfig.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/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> +<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/FileWriterCycleConfig.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterCycleConfig.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterCycleConfig.html new file mode 100644 index 0000000..b29ad0a --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterCycleConfig.html @@ -0,0 +1,503 @@ +<!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>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="FileWriterCycleConfig (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":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="../../../../../org/apache/edgent/connectors/file/FileStreams.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/FileWriterFlushConfig.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/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">org.apache.edgent.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>org.apache.edgent.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="../../../../../org/apache/edgent/connectors/file/FileWriterRetentionConfig.html" title="class in org.apache.edgent.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="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html#evaluate-long-int-T-">evaluate</a></span>(long fileSize, + int nTuples, + <a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="type parameter in FileWriterCycleConfig">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T></code></td> +<td class="colLast"><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 id="i6" 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"><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 id="i7" 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"><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 id="i8" 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"><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 id="i9" 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"><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> +<tr id="i10" 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/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="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T> newFileSizeBasedConfig(long fileSize)</pre> +<div class="block">same as <code>newConfig(fileSize, 0, 0, null)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fileSize</code> - cycle after <code>fileSize</code> bytes have been written. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the cycle configuration</dd> +</dl> +</li> +</ul> +<a name="newCountBasedConfig-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newCountBasedConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T> newCountBasedConfig(int cntTuples)</pre> +<div class="block">same as <code>newConfig(0, cntTuples, 0, null)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cntTuples</code> - cycle after every <code>cntTuple</code> tuples have been written. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the cycle configuration</dd> +</dl> +</li> +</ul> +<a name="newTimeBasedConfig-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newTimeBasedConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T> newTimeBasedConfig(long periodMsec)</pre> +<div class="block">same as <code>newConfig(0, 0, periodMsec, null)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>periodMsec</code> - cycle after <code>periodMsec</code> has elapsed since the last time based cycle. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the cycle configuration</dd> +</dl> +</li> +</ul> +<a name="newPredicateBasedConfig-org.apache.edgent.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newPredicateBasedConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T> newPredicateBasedConfig(<a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T> tuplePredicate)</pre> +<div class="block">same as <code>newConfig(0, 0, 0, tuplePredicate)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tuplePredicate</code> - cycle if <code>tuplePredicate</code> returns true. null to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the cycle configuration</dd> +</dl> +</li> +</ul> +<a name="newConfig-long-int-long-org.apache.edgent.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterCycleConfig</a><T> newConfig(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)</pre> +<div class="block">Create a new configuration. + <p> + At least one configuration mode must be enabled.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the cycle configuration</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="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/file/FileStreams.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/FileWriterFlushConfig.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/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 - 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/FileWriterFlushConfig.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterFlushConfig.html b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterFlushConfig.html new file mode 100644 index 0000000..84c93bd --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/connectors/file/FileWriterFlushConfig.html @@ -0,0 +1,477 @@ +<!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>FileWriterFlushConfig (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="FileWriterFlushConfig (Edgent 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="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.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/FileWriterPolicy.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/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">org.apache.edgent.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>org.apache.edgent.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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html#evaluate-int-T-">evaluate</a></span>(int nTuples, + <a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="type parameter in FileWriterFlushConfig">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html#newConfig-int-long-org.apache.edgent.function.Predicate-">newConfig</a></span>(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 id="i5" class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.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, tuplePredicate)</code></div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.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> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the flush configuration</dd> +</dl> +</li> +</ul> +<a name="newCountBasedConfig-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newCountBasedConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T> newCountBasedConfig(int cntTuples)</pre> +<div class="block">same as <code>newConfig(cntTuples, 0, null)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cntTuples</code> - flush every <code>cntTuple</code> tuples written. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the flush configuration</dd> +</dl> +</li> +</ul> +<a name="newTimeBasedConfig-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newTimeBasedConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T> newTimeBasedConfig(long periodMsec)</pre> +<div class="block">same as <code>newConfig(0, periodMsec, null)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>periodMsec</code> - flush every <code>periodMsec</code> milliseconds. 0 to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the flush configuration</dd> +</dl> +</li> +</ul> +<a name="newPredicateBasedConfig-org.apache.edgent.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newPredicateBasedConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T> newPredicateBasedConfig(<a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T> tuplePredicate)</pre> +<div class="block">same as <code>newConfig(0, 0, tuplePredicate)</code></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tuplePredicate</code> - flush if <code>tuplePredicate</code> is true. null to disable.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the flush configuration</dd> +</dl> +</li> +</ul> +<a name="newConfig-int-long-org.apache.edgent.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newConfig</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/connectors/file/FileWriterFlushConfig.html" title="class in org.apache.edgent.connectors.file">FileWriterFlushConfig</a><T> newConfig(int cntTuples, + long periodMsec, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.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">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type</dd> +<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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the flush configuration</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="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/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="../../../../../org/apache/edgent/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://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/connectors/file/FileWriterCycleConfig.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/FileWriterPolicy.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/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 - 54ea8ac-20160726-1240</small></p> +</body> +</html>
