Repository: beam
Updated Branches:
  refs/heads/master 5fd5828d1 -> 766a02dbc


Add javadoc to getEstimatedSizeBytes

based on code comment in BoundedReadFromUnboundedSource.java


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

Branch: refs/heads/master
Commit: 56fe0f182d965d3e1d87dfbd8cdeef90b596a905
Parents: 5fd5828
Author: wtanaka.com <[email protected]>
Authored: Sun Apr 2 20:02:02 2017 -1000
Committer: Jean-Baptiste Onofré <[email protected]>
Committed: Thu Apr 6 08:06:45 2017 +0200

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


http://git-wip-us.apache.org/repos/asf/beam/blob/56fe0f18/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
----------------------------------------------------------------------
diff --git 
a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java 
b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
index 8538e7f..889f9ab 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/io/BoundedSource.java
@@ -61,6 +61,9 @@ public abstract class BoundedSource<T> extends Source<T> {
    * An estimate of the total size (in bytes) of the data that would be read 
from this source.
    * This estimate is in terms of external storage size, before any 
decompression or other
    * processing done by the reader.
+   *
+   * If there is no way to estimate the size of the source
+   * implementations MAY return 0L
    */
   public abstract long getEstimatedSizeBytes(PipelineOptions options) throws 
Exception;
 

Reply via email to