beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tg...@apache.org
Subject [2/2] beam git commit: Mark PValue and PValueBase Internal
Date Wed, 10 May 2017 04:02:07 GMT
Mark PValue and PValueBase Internal

These should not be referred to as their abstract types by users, and
PipelineRunners won't interact with PValues that aren't PCollections or
PCollectionViews.


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

Branch: refs/heads/master
Commit: 3499c70a2fde0124dfc48ae20281c2261ef9018a
Parents: e2be696
Author: Thomas Groh <tgroh@google.com>
Authored: Tue May 9 18:32:14 2017 -0700
Committer: Thomas Groh <tgroh@google.com>
Committed: Tue May 9 21:01:52 2017 -0700

----------------------------------------------------------------------
 .../main/java/org/apache/beam/sdk/values/PValue.java | 12 +++++++-----
 .../java/org/apache/beam/sdk/values/PValueBase.java  | 15 +++++----------
 2 files changed, 12 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam/blob/3499c70a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValue.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValue.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValue.java
index d9f6920..1089028 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValue.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValue.java
@@ -18,13 +18,15 @@
 package org.apache.beam.sdk.values;
 
 import java.util.Map;
+import org.apache.beam.sdk.annotations.Internal;
 import org.apache.beam.sdk.transforms.PTransform;
 
 /**
- * The interface for values that can be input to and output from {@link PTransform PTransforms}.
+ * <b><i>For internal use. No backwards compatibility guarantees.</i></b>
  *
- * <p>It is recommended to extend {@link PValueBase}
+ * <p>A primitive value within Beam.
  */
+@Internal
 public interface PValue extends POutput, PInput {
 
   /**
@@ -45,13 +47,13 @@ public interface PValue extends POutput, PInput {
    * After building, finalizes this {@code PValue} to make it ready for being used as an
input to a
    * {@link org.apache.beam.sdk.transforms.PTransform}.
    *
-   * <p>Automatically invoked whenever {@code apply()} is invoked on this {@code PValue},
after
-   * {@link PValue#finishSpecifying(PInput, PTransform)} has been called on each component
{@link
-   * PValue}, so users do not normally call this explicitly.
+   * <p>Automatically invoked whenever {@code apply()} is invoked on this {@code PValue}.
Users
+   * should not normally call this explicitly.
    *
    * @param upstreamInput the {@link PInput} the {@link PTransform} was applied to to produce
this
    *     output
    * @param upstreamTransform the {@link PTransform} that produced this {@link PValue}
    */
+  @Internal
   void finishSpecifying(PInput upstreamInput, PTransform<?, ?> upstreamTransform);
 }

http://git-wip-us.apache.org/repos/asf/beam/blob/3499c70a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValueBase.java
----------------------------------------------------------------------
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValueBase.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValueBase.java
index 4de0589..6f638d7 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValueBase.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValueBase.java
@@ -22,22 +22,17 @@ import static com.google.common.base.Preconditions.checkState;
 import java.util.Collections;
 import java.util.Map;
 import org.apache.beam.sdk.Pipeline;
+import org.apache.beam.sdk.annotations.Internal;
 import org.apache.beam.sdk.transforms.PTransform;
 import org.apache.beam.sdk.util.NameUtils;
 
 /**
- * A {@link PValueBase} is an abstract base class that provides
- * sensible default implementations for methods of {@link PValue}.
- * In particular, this includes functionality for getting/setting:
+ * <b><i>For internal use. No backwards compatibility guarantees.</i></b>
  *
- * <ul>
- *   <li> The {@link Pipeline} that the {@link PValue} is part of.</li>
- *   <li> Whether the {@link PValue} has bee finalized (as an input
- *     or an output), after which its properties can no longer be changed.</li>
- * </ul>
- *
- * <p>For internal use.
+ * <p>An abstract base class that provides default implementations for some methods
of
+ * {@link PValue}.
  */
+@Internal
 public abstract class PValueBase implements PValue {
 
   private final Pipeline pipeline;


Mime
View raw message