beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k...@apache.org
Subject [2/3] beam git commit: Minor touch-ups to new BoundedWindow javadoc
Date Mon, 22 May 2017 19:05:58 GMT
Minor touch-ups to new BoundedWindow javadoc


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

Branch: refs/heads/master
Commit: 143334ca532076c839e5699171c8d9db8743b6a2
Parents: de0fdbc
Author: Kenneth Knowles <klk@google.com>
Authored: Mon May 22 12:04:53 2017 -0700
Committer: Kenneth Knowles <klk@google.com>
Committed: Mon May 22 12:04:53 2017 -0700

----------------------------------------------------------------------
 .../sdk/transforms/windowing/BoundedWindow.java | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam/blob/143334ca/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
index 506753d..92fa3c5 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/BoundedWindow.java
@@ -21,19 +21,19 @@ import java.util.concurrent.TimeUnit;
 import org.joda.time.Instant;
 
 /**
- * A {@code BoundedWindow} represents window information assigned to data elements.
+ * A {@link BoundedWindow} represents window information assigned to data elements.
  *
- * <p>It has one method {@link #maxTimestamp()} to define an upper bound(included)
of element
- * timestamp. Elements within the timestamp range are placed in this window.
- * Technically a window may not have a lower bound. Upper bound is mandatory as watermark,
- * which also controls discarding data and expiring the window, is based on event timestamp.
+ * <p>It has one method {@link #maxTimestamp()} to define an upper bound (inclusive)
for element
+ * timestamps. A {@link WindowFn} must assign an element only to windows where {@link
+ * #maxTimestamp()} is greater than or equal to the element timestamp. When the watermark
passes the
+ * maximum timestamp, all data for a window is estimated to be received.
  *
- * <p>At some point in time, usually when watermark passes,
- * all data with the same window will arrive and can be processed together.
+ * <p>A window does not need to have a lower bound. Only the upper bound is mandatory
because it
+ * governs management of triggering and discarding of the window.
  *
- * <p>Windows must also implement {@link Object#equals} and
- * {@link Object#hashCode} such that windows that are logically equal will
- * be treated as equal by {@code equals()} and {@code hashCode()}.
+ * <p>Windows must also implement {@link Object#equals} and {@link Object#hashCode}
such that
+ * windows that are logically equal will be treated as equal by {@code equals()} and {@code
+ * hashCode()}.
  */
 public abstract class BoundedWindow {
   // The min and max timestamps that won't overflow when they are converted to


Mime
View raw message