File tree Expand file tree Collapse file tree 2 files changed +12
-15
lines changed
sdks/java/core/src/main/java/org/apache/beam/sdk/values Expand file tree Collapse file tree 2 files changed +12
-15
lines changed Original file line number Diff line number Diff line change 18
18
package org .apache .beam .sdk .values ;
19
19
20
20
import java .util .Map ;
21
+ import org .apache .beam .sdk .annotations .Internal ;
21
22
import org .apache .beam .sdk .transforms .PTransform ;
22
23
23
24
/**
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>
25
26
*
26
- * <p>It is recommended to extend {@link PValueBase}
27
+ * <p>A primitive value within Beam.
27
28
*/
29
+ @ Internal
28
30
public interface PValue extends POutput , PInput {
29
31
30
32
/**
@@ -45,13 +47,13 @@ public interface PValue extends POutput, PInput {
45
47
* After building, finalizes this {@code PValue} to make it ready for being used as an input to a
46
48
* {@link org.apache.beam.sdk.transforms.PTransform}.
47
49
*
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.
51
52
*
52
53
* @param upstreamInput the {@link PInput} the {@link PTransform} was applied to to produce this
53
54
* output
54
55
* @param upstreamTransform the {@link PTransform} that produced this {@link PValue}
55
56
*/
57
+ @ Internal
56
58
void finishSpecifying (PInput upstreamInput , PTransform <?, ?> upstreamTransform );
57
59
}
Original file line number Diff line number Diff line change 22
22
import java .util .Collections ;
23
23
import java .util .Map ;
24
24
import org .apache .beam .sdk .Pipeline ;
25
+ import org .apache .beam .sdk .annotations .Internal ;
25
26
import org .apache .beam .sdk .transforms .PTransform ;
26
27
import org .apache .beam .sdk .util .NameUtils ;
27
28
28
29
/**
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>
32
31
*
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}.
40
34
*/
35
+ @ Internal
41
36
public abstract class PValueBase implements PValue {
42
37
43
38
private final Pipeline pipeline ;
You can’t perform that action at this time.
0 commit comments