Skip to content

Commit d814ab7

Browse files
improved javadoc documentation
1 parent 25af774 commit d814ab7

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

  • sdks/java/core/src/main/java/org/apache/beam/sdk/coders

sdks/java/core/src/main/java/org/apache/beam/sdk/coders/Coder.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,16 @@
6969
* </ul>
7070
*
7171
* @param <T> the type of values handled by this {@link Coder}
72+
*
73+
* <p>The behavior of encoding and decoding depends on the {@link Context}.
74+
*
75+
* <ul>
76+
* <li>In {@link Context#OUTER}, the value consumes the remainder of the stream.
77+
* <li>In {@link Context#NESTED}, the value is part of a larger structure and must be
78+
* self-delimiting so that subsequent values can be correctly decoded.
79+
* </ul>
80+
*
81+
* <p>See {@link CoderProperties} for utilities to test coder correctness and consistency.
7282
*/
7383
public abstract class Coder<T> implements Serializable {
7484
/**

0 commit comments

Comments
 (0)