Skip to content

Improve Javadoc for Coder class and clarify Context usage #38235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stankiewicz merged 4 commits into from
Apr 20, 2026
+5 −0
Merged

Improve Javadoc for Coder class and clarify Context usage #38235

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dba250f
improved Coder documentation
Subramanya-Veeregowda Apr 17, 2026
bfd1a2d
fix: improved javadoc for Coder
Subramanya-Veeregowda Apr 18, 2026
fa4019b
trigger ci after spotless fix
Subramanya-Veeregowda Apr 18, 2026
c3d3c1e
improved javadoc for Coder file
Subramanya-Veeregowda Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions sdks/java/core/src/main/java/org/apache/beam/sdk/coders/Coder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@
* <p>All methods of a {@link Coder} are required to be thread safe.
*
* @param <T> the type of values being encoded and decoded
* <p>The behavior of encoding and decoding depends on the {@link Context}.
* <p>In {@link Context#OUTER}, the value consumes the remainder of the stream.
* <p>In {@link Context#NESTED}, the value is part of a larger structure and must be
* self-delimiting so that subsequent values can be correctly decoded.
* <p>See {@link CoderProperties} for utilities to test coder correctness and consistency.
*/
public abstract class Coder<T> implements Serializable {
/**
Expand Down
Loading