beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lc...@apache.org
Subject [3/8] incubator-beam git commit: Added even more javadoc to TextIO#withHeader and TextIO#withFooter (2).
Date Wed, 07 Sep 2016 22:39:39 GMT
Added even more javadoc to TextIO#withHeader and TextIO#withFooter (2).


Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/f21875e2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/f21875e2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/f21875e2

Branch: refs/heads/master
Commit: f21875e2fe85572e83c933ba409626d509209119
Parents: b1176de
Author: Stas Levin <staslevin@gmail.com>
Authored: Thu Sep 8 00:02:52 2016 +0300
Committer: Luke Cwik <lcwik@google.com>
Committed: Wed Sep 7 15:35:31 2016 -0700

----------------------------------------------------------------------
 .../main/java/org/apache/beam/sdk/io/TextIO.java    | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/f21875e2/sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextIO.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextIO.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextIO.java
index f09ab6c..e4fcc32 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextIO.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/TextIO.java
@@ -632,11 +632,27 @@ public class TextIO {
             shardTemplate, false);
       }
 
+      /**
+       * Returns a transform for writing to text files that adds a header string to the files
+       * it writes.
+       *
+       *<p> A <code>null</code> value will clear any previously configured
header.</p>
+       *
+       * @param header the string to be added as file header
+       */
       public Bound<T> withHeader(String header) {
         return new Bound<>(name, filenamePrefix, filenameSuffix, header, footer, coder,
numShards,
             shardTemplate, false);
       }
 
+      /**
+       * Returns a transform for writing to text files that adds a footer string to the files
+       * it writes.
+       *
+       *<p> A <code>null</code> value will clear any previously configured
footer.</p>
+       *
+       * @param footer the string to be added as file footer
+       */
       public Bound<T> withFooter(String footer) {
         return new Bound<>(name, filenamePrefix, filenameSuffix, header, footer, coder,
numShards,
             shardTemplate, false);


Mime
View raw message