Revise StepContext javadoc
Project: http://git-wip-us.apache.org/repos/asf/beam/repo Commit: http://git-wip-us.apache.org/repos/asf/beam/commit/d425b279 Tree: http://git-wip-us.apache.org/repos/asf/beam/tree/d425b279 Diff: http://git-wip-us.apache.org/repos/asf/beam/diff/d425b279 Branch: refs/heads/master Commit: d425b2792f754ed6150f7b47eddf743286a45401 Parents: 0dc0334 Author: Kenneth Knowles <[email protected]> Authored: Tue May 23 11:10:42 2017 -0700 Committer: Kenneth Knowles <[email protected]> Committed: Tue May 23 11:16:35 2017 -0700 ---------------------------------------------------------------------- .../main/java/org/apache/beam/runners/core/StepContext.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam/blob/d425b279/runners/core-java/src/main/java/org/apache/beam/runners/core/StepContext.java ---------------------------------------------------------------------- diff --git a/runners/core-java/src/main/java/org/apache/beam/runners/core/StepContext.java b/runners/core-java/src/main/java/org/apache/beam/runners/core/StepContext.java index 60fc402..4d66d66 100644 --- a/runners/core-java/src/main/java/org/apache/beam/runners/core/StepContext.java +++ b/runners/core-java/src/main/java/org/apache/beam/runners/core/StepContext.java @@ -18,7 +18,12 @@ package org.apache.beam.runners.core; /** - * Per-step, per-key context used for retrieving state. + * The context in which a specific step is executing, including access to state and timers. + * + * <p>This interface exists as the API between a runner and the support code, but is not user + * facing. + * + * <p>These will often be scoped to a particular step and key, though it is not required. */ public interface StepContext {
