Skip to content

Commit cc29703

Browse files
committed
Add missing documentation
1 parent 92cff92 commit cc29703

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

wayang-commons/wayang-core/src/main/java/org/apache/wayang/core/plan/executionplan/ExecutionPlan.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,10 @@ public String toExtensiveString(boolean isStriclyOrdering) {
9696
}
9797

9898
/**
99-
* TODO: ExecutionPlan.toJsonList add documentation
100-
* labels:documentation,todo
99+
* Converts this execution plan into a list of maps, where each map represents an {@link ExecutionStage}.
100+
* The stages are included in an order that respects their dependencies.
101101
*
102-
* @return
102+
* @return a list of maps representing the execution stages
103103
*/
104104
public List<Map> toJsonList() {
105105
Counter<ExecutionStage> stageActivationCounter = new Counter<>();

wayang-commons/wayang-core/src/main/java/org/apache/wayang/core/plan/executionplan/ExecutionStage.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,11 @@ private void toExtensiveStringAux(ExecutionTask task, Set<ExecutionTask> seenTas
313313
}
314314
}
315315

316+
/**
317+
* Converts this instance into a map that can be serialized into a JSON.
318+
*
319+
* @return a map representing this instance
320+
*/
316321
public Map toJsonMap() {
317322
HashMap<String, Object> jsonMap = new HashMap<>();
318323
ArrayList<Map> operators = new ArrayList<>();

0 commit comments

Comments
 (0)