Skip to content

Commit 4b2ac4b

Browse files
Add missing JavaDocs
1 parent 69d2363 commit 4b2ac4b

3 files changed

Lines changed: 27 additions & 0 deletions

File tree

temporal-sdk/src/main/java/io/temporal/common/interceptors/ActivityInboundCallsInterceptor.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ public Object getResult() {
4343
}
4444
}
4545

46+
/**
47+
* Provides the interceptor with the {@link ActivityExecutionContext} for the intercepted activity
48+
* invocation.
49+
*
50+
* @param context execution context associated with the running activity.
51+
*/
4652
void init(ActivityExecutionContext context);
4753

4854
/**

temporal-sdk/src/main/java/io/temporal/payload/codec/PayloadCodec.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,22 @@
1414
* Encoder implementation.
1515
*/
1616
public interface PayloadCodec {
17+
/**
18+
* Applies the codec-specific encoding to the provided payloads.
19+
*
20+
* @param payloads the payloads that should be encoded.
21+
* @return a list containing the encoded representations of {@code payloads}.
22+
*/
1723
@Nonnull
1824
List<Payload> encode(@Nonnull List<Payload> payloads);
1925

26+
/**
27+
* Reverses {@link #encode(List) encode(List)} by decoding the provided payloads back to their
28+
* original representation.
29+
*
30+
* @param payloads the encoded payloads to decode.
31+
* @return the decoded payloads that can be consumed by the SDK or user code.
32+
*/
2033
@Nonnull
2134
List<Payload> decode(@Nonnull List<Payload> payloads);
2235

temporal-sdk/src/main/java/io/temporal/workflow/QueueConsumer.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
import java.time.Duration;
44

5+
/**
6+
* A deterministic queue consumer that can be used from workflow code to retrieve items from a
7+
* {@link WorkflowQueue}. Implementations mirror the Temporal workflow concurrency model, providing
8+
* blocking, cancellable, and non-blocking operations that never interact with standard Java
9+
* threading primitives.
10+
*
11+
* @param <E> type of the elements stored in the queue
12+
*/
513
public interface QueueConsumer<E> {
614

715
/**

0 commit comments

Comments
 (0)