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/5084580f Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/5084580f Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/5084580f Branch: refs/heads/gearpump-runner Commit: 5084580f0f11f97df00c1c972056acaae713c41f Parents: 092a187 Author: Stas Levin <stasle...@gmail.com> Authored: Wed Sep 7 18:33:48 2016 +0300 Committer: Dan Halperin <dhalp...@google.com> Committed: Mon Sep 12 17:40:14 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/5084580f/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); }
