Mark TimeDomain experimental alongside Timers; improve javadoc
Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/b4c808a0 Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/b4c808a0 Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/b4c808a0 Branch: refs/heads/master Commit: b4c808a045d493e93d83c815dc7520c6b213858a Parents: ca41af8 Author: Kenneth Knowles <k...@google.com> Authored: Tue May 2 12:31:02 2017 -0700 Committer: Kenneth Knowles <k...@google.com> Committed: Thu May 4 16:06:55 2017 -0700 ---------------------------------------------------------------------- .../org/apache/beam/sdk/state/TimeDomain.java | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam/blob/b4c808a0/sdks/java/core/src/main/java/org/apache/beam/sdk/state/TimeDomain.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/state/TimeDomain.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/state/TimeDomain.java index e814915..0526453 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/state/TimeDomain.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/state/TimeDomain.java @@ -17,27 +17,29 @@ */ package org.apache.beam.sdk.state; +import org.apache.beam.sdk.annotations.Experimental; + /** - * {@code TimeDomain} specifies whether an operation is based on - * timestamps of elements or current "real-world" time as reported while processing. + * {@link TimeDomain} specifies whether an operation is based on timestamps of elements or current + * "real-world" time as reported while processing. */ +@Experimental(Experimental.Kind.TIMERS) public enum TimeDomain { /** - * The {@code EVENT_TIME} domain corresponds to the timestamps on the elements. Time advances - * on the system watermark advances. + * The {@link #EVENT_TIME} domain corresponds to the timestamps on the elements. Time advances on + * the system watermark advances. */ EVENT_TIME, /** - * The {@code PROCESSING_TIME} domain corresponds to the current to the current (system) time. + * The {@link #PROCESSING_TIME} domain corresponds to the current to the current (system) time. * This is advanced during execution of the pipeline. */ PROCESSING_TIME, /** - * Same as the {@code PROCESSING_TIME} domain, except it won't fire a timer set for time - * {@code T} until all timers from earlier stages set for a time earlier than {@code T} have - * fired. + * Same as the {@link #PROCESSING_TIME} domain, except it won't fire a timer set for time <i>t</i> + * until all timers from earlier stages set for a time earlier than <i>t</i> have fired. */ SYNCHRONIZED_PROCESSING_TIME }
