Skip to content

Commit 8312b6f

Browse files
committed
This closes #3033
2 parents e2be696 + 3499c70 commit 8312b6f

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValue.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@
1818
package org.apache.beam.sdk.values;
1919

2020
import java.util.Map;
21+
import org.apache.beam.sdk.annotations.Internal;
2122
import org.apache.beam.sdk.transforms.PTransform;
2223

2324
/**
24-
* The interface for values that can be input to and output from {@link PTransform PTransforms}.
25+
* <b><i>For internal use. No backwards compatibility guarantees.</i></b>
2526
*
26-
* <p>It is recommended to extend {@link PValueBase}
27+
* <p>A primitive value within Beam.
2728
*/
29+
@Internal
2830
public interface PValue extends POutput, PInput {
2931

3032
/**
@@ -45,13 +47,13 @@ public interface PValue extends POutput, PInput {
4547
* After building, finalizes this {@code PValue} to make it ready for being used as an input to a
4648
* {@link org.apache.beam.sdk.transforms.PTransform}.
4749
*
48-
* <p>Automatically invoked whenever {@code apply()} is invoked on this {@code PValue}, after
49-
* {@link PValue#finishSpecifying(PInput, PTransform)} has been called on each component {@link
50-
* PValue}, so users do not normally call this explicitly.
50+
* <p>Automatically invoked whenever {@code apply()} is invoked on this {@code PValue}. Users
51+
* should not normally call this explicitly.
5152
*
5253
* @param upstreamInput the {@link PInput} the {@link PTransform} was applied to to produce this
5354
* output
5455
* @param upstreamTransform the {@link PTransform} that produced this {@link PValue}
5556
*/
57+
@Internal
5658
void finishSpecifying(PInput upstreamInput, PTransform<?, ?> upstreamTransform);
5759
}

sdks/java/core/src/main/java/org/apache/beam/sdk/values/PValueBase.java

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,17 @@
2222
import java.util.Collections;
2323
import java.util.Map;
2424
import org.apache.beam.sdk.Pipeline;
25+
import org.apache.beam.sdk.annotations.Internal;
2526
import org.apache.beam.sdk.transforms.PTransform;
2627
import org.apache.beam.sdk.util.NameUtils;
2728

2829
/**
29-
* A {@link PValueBase} is an abstract base class that provides
30-
* sensible default implementations for methods of {@link PValue}.
31-
* In particular, this includes functionality for getting/setting:
30+
* <b><i>For internal use. No backwards compatibility guarantees.</i></b>
3231
*
33-
* <ul>
34-
* <li> The {@link Pipeline} that the {@link PValue} is part of.</li>
35-
* <li> Whether the {@link PValue} has bee finalized (as an input
36-
* or an output), after which its properties can no longer be changed.</li>
37-
* </ul>
38-
*
39-
* <p>For internal use.
32+
* <p>An abstract base class that provides default implementations for some methods of
33+
* {@link PValue}.
4034
*/
35+
@Internal
4136
public abstract class PValueBase implements PValue {
4237

4338
private final Pipeline pipeline;

0 commit comments

Comments
 (0)