beam-commits mailing list archives

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


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

Branch: refs/heads/master
Commit: 94c58b61411e78da8bb844e4167a51fb2894692e
Parents: 0e8ff41
Author: Stas Levin <staslevin@gmail.com>
Authored: Wed Sep 7 18:33:48 2016 +0300
Committer: Luke Cwik <lcwik@google.com>
Committed: Wed Sep 7 15:35:31 2016 -0700

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


http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/94c58b61/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 0895123..e75aaa9 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
@@ -448,10 +448,22 @@ public class TextIO {
       return new Bound<>(DEFAULT_TEXT_CODER).withoutValidation();
     }
 
+    /**
+     * Returns a transform for writing to text files that adds a header string to the files
+     * it writes.
+     *
+     * @param header the string to be added as file header
+     */
     public static Bound<String> withHeader(String header) {
       return new Bound<>(DEFAULT_TEXT_CODER).withHeader(header);
     }
 
+    /**
+     * Returns a transform for writing to text files that adds a footer string to the files
+     * it writes.
+     *
+     * @param footer the string to be added as file footer
+     */
     public static Bound<String> withFooter(String footer) {
       return new Bound<>(DEFAULT_TEXT_CODER).withFooter(footer);
     }


Mime
View raw message