Fix Javadoc of ReadableState
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/caf1fb70 Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/caf1fb70 Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/caf1fb70 Branch: refs/heads/gearpump-runner Commit: caf1fb705e785cb312cedc334efa73e081469da0 Parents: a9a41eb Author: Aljoscha Krettek <[email protected]> Authored: Mon Oct 24 10:35:41 2016 +0200 Committer: Aljoscha Krettek <[email protected]> Committed: Mon Oct 24 10:39:07 2016 +0200 ---------------------------------------------------------------------- .../org/apache/beam/sdk/util/state/ReadableState.java | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/caf1fb70/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/ReadableState.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/ReadableState.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/ReadableState.java index ea8a231..3b4cb7b 100644 --- a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/ReadableState.java +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/state/ReadableState.java @@ -21,14 +21,10 @@ import org.apache.beam.sdk.annotations.Experimental; import org.apache.beam.sdk.annotations.Experimental.Kind; /** - * A {@code StateContents} is produced by the read methods on all {@link State} objects. - * Calling {@link #read} returns the associated value. + * {@link State} that can be read via {@link #read()}. * - * <p>This class is similar to {@link java.util.concurrent.Future}, but each invocation of - * {@link #read} need not return the same value. - * - * <p>Getting the {@code StateContents} from a read method indicates the desire to eventually - * read a value. Depending on the runner this may or may not immediately start the read. + * <p>Use {@link #readLater()} for marking several states for prefetching. Runners + * can potentially batch these into one read. * * @param <T> The type of value returned by {@link #read}. */
