Make Task.parent() protected

gselzer · gselzer · commit fa44b11fc0fb · 2024-05-06T16:26:13.000-05:00
We want to propagate progress updates up the chain of subtasks, so tasks
must know their parent, at least within the scijava-progress module. To
avoid publicly exposing this functionality, though, we make a new method
isSubTask which allows us to optionally disregard all subtasks.
diff --git a/scijava-ops-legacy/src/main/java/org/scijava/legacy/service/DefaultOpEnvironmentService.java b/scijava-ops-legacy/src/main/java/org/scijava/legacy/service/DefaultOpEnvironmentService.java
@@ -86,7 +86,7 @@ public SciJavaProgressListener(TaskService tasks) {
 
 		@Override
 		public void acknowledgeUpdate(Task task) {
-			if (task.parent() != null) return;
+			if (task.isSubTask()) return;
 			var sjTask = taskMap.computeIfAbsent( //
 				task, //
 				(t) -> { //
diff --git a/scijava-progress/src/main/java/org/scijava/progress/Task.java b/scijava-progress/src/main/java/org/scijava/progress/Task.java
@@ -250,7 +250,11 @@ public Object progressible() {
 	 *
 	 * @return the parent {@link Task}, or {@code null} if this Task has no parent
 	 */
-	public Task parent() {
+	protected Task parent() {
 		return parent;
 	}
+
+	public boolean isSubTask() {
+		return parent != null;
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -250,7 +250,11 @@ public Object progressible() {`
`250`	`250`	`*`
`251`	`251`	`* @return the parent {@link Task}, or {@code null} if this Task has no parent`
`252`	`252`	`*/`
`253`		`- public Task parent() {`
	`253`	`+ protected Task parent() {`
`254`	`254`	`return parent;`
`255`	`255`	`}`
	`256`	`+`
	`257`	`+ public boolean isSubTask() {`
	`258`	`+ return parent != null;`
	`259`	`+ }`
`256`	`260`	`}`