[Docs][Core] Add Javadoc to TaskExecutionService inner classes#10691
Open
xxzuo wants to merge 4 commits into
Open
[Docs][Core] Add Javadoc to TaskExecutionService inner classes#10691xxzuo wants to merge 4 commits into
xxzuo wants to merge 4 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds comprehensive Javadoc to TaskExecutionService (SeaTunnel Engine server) to clarify task deployment, lifecycle management, and the cooperative vs. blocking execution model, as part of issue #10546.
Changes:
- Expanded class-level documentation describing responsibilities and execution modes.
- Added/updated Javadoc on key fields and public/private methods.
- Added detailed Javadoc for inner classes involved in cooperative and blocking execution.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
DanielLeens
approved these changes
Apr 6, 2026
Contributor
DanielLeens
left a comment
There was a problem hiding this comment.
I pulled the diff locally and did not find a blocking issue here.
This stays in the documentation/Javadoc layer, and the added descriptions are aligned with the current execution structure in TaskExecutionService rather than changing behavior. From my side this looks fine to merge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #10546
Purpose of this pull request
This pull request adds comprehensive Javadoc documentation to
TaskExecutionServiceclass, which is part of issue #10546 (sub-task of #10533) to add Javadoc to key lifecycle, checkpoint, and multi-table related classes.The Javadoc improvements include:
1. Class-level Javadoc:
<ul>lists detailing the service responsibilities@seereferences to related internal classes (CooperativeTaskWorker,BlockingWorker,TaskGroupExecutionTracker)2. Field Javadoc:
hzInstanceName,nodeEngine,classLoaderService,executorService,executionContexts,finishedExecutionContexts, etc.3. Method Javadoc:
start(),shutdown(),getExecutionContext(),getActiveExecutionContext(),deployTask(),deployLocalTask(),getTask(),cancelTaskGroup(),asyncExecuteFunction(),notifyCleanTaskGroupContext(),reportEvent(),getSeaTunnelConfig(),getServerConnectorPackageClient(),printTaskExecutionRuntimeInfo()submitThreadShareTask(),submitBlockingTask(),notifyTaskStatusToMaster()4. Inner Class Javadoc:
CooperativeTaskWorker- improved class documentationCooperativeTaskWorker.run()- added detailed execution flow with<ol>listRunBusWorkSupplier- improved class and method documentationBlockingWorker.run()- added detailed execution flow with<ol>listTaskGroupExecutionTracker.taskDone()- added completion handling documentationTaskGroupExecutionTracker.exception()- added exception recording documentationBlockingTaskThreadFactory- added thread naming pattern documentationNamedTaskWrapper- added documentationDoes this PR introduce any user-facing change?
No. This is a documentation-only change that adds Javadoc comments to improve code readability and maintainability. No user-facing behavior is changed.
How was this patch tested?
./mvnw spotless:applypassed (formatting verified)Check list
New License Guide
incompatible-changes.mdto describe the incompatibility caused by this PR.