Small fixes
-Fixed: JavaDoc -Changed: callback is now called onCompletion
This commit is contained in:
parent
166362334b
commit
2810a6f952
|
@ -68,15 +68,15 @@ import speiger.src.collections.utils.SanityChecks;
|
||||||
* The Task Object is also pause-able/Interruptable at any moment during the Processing. <br>
|
* The Task Object is also pause-able/Interruptable at any moment during the Processing. <br>
|
||||||
*
|
*
|
||||||
* A small example
|
* A small example
|
||||||
* <pre>
|
* <pre><code>
|
||||||
* public void processFiles(ObjectCollection<String> potentialFiles) {
|
* public void processFiles(ObjectCollection<String> potentialFiles) {
|
||||||
* potentialFiles.asAsync()
|
* potentialFiles.asAsync()
|
||||||
* .map(Paths::get).filter(Files::exists) //Modifies the collection (Optional)
|
* .map(Paths::get).filter(Files::exists) //Modifies the collection (Optional)
|
||||||
* .forEach(Files::delete) //Creates the action (Required)
|
* .forEach(Files::delete) //Creates the action (Required)
|
||||||
* .callback(T -> {}} //Callback on completion (Optional)
|
* .onCompletion(T -> {}} //Callback on completion (Optional)
|
||||||
* .execute() //Starts the task. (Required)
|
* .execute() //Starts the task. (Required)
|
||||||
* }
|
* }
|
||||||
* </pre>
|
* </code></pre>
|
||||||
* @author Speiger
|
* @author Speiger
|
||||||
*
|
*
|
||||||
* @Type(T)
|
* @Type(T)
|
||||||
|
@ -88,7 +88,7 @@ public class ASYNC_BUILDER KEY_GENERIC_TYPE
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Main Constructor that uses a Iterable to build a Offthread Task.
|
* Main Constructor that uses a Iterable to build a Offthread Task.
|
||||||
* @param iterable
|
* @param iterable that should be processed
|
||||||
*/
|
*/
|
||||||
public ASYNC_BUILDER(ITERABLE KEY_GENERIC_TYPE iterable) {
|
public ASYNC_BUILDER(ITERABLE KEY_GENERIC_TYPE iterable) {
|
||||||
this.iterable = iterable;
|
this.iterable = iterable;
|
||||||
|
@ -96,7 +96,7 @@ public class ASYNC_BUILDER KEY_GENERIC_TYPE
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Helper constructor.
|
* Helper constructor.
|
||||||
* @param task
|
* @param task that had been build
|
||||||
*/
|
*/
|
||||||
public ASYNC_BUILDER(BASE_TASK KEY_GENERIC_TYPE task) {
|
public ASYNC_BUILDER(BASE_TASK KEY_GENERIC_TYPE task) {
|
||||||
this.task = task;
|
this.task = task;
|
||||||
|
@ -310,7 +310,7 @@ public class ASYNC_BUILDER KEY_GENERIC_TYPE
|
||||||
* @return self with the callback set
|
* @return self with the callback set
|
||||||
* @note can be null
|
* @note can be null
|
||||||
*/
|
*/
|
||||||
public ASYNC_BUILDER KEY_GENERIC_TYPE callback(Consumer<TASK KEY_GENERIC_TYPE> callback) {
|
public ASYNC_BUILDER KEY_GENERIC_TYPE onCompletion(Consumer<TASK KEY_GENERIC_TYPE> callback) {
|
||||||
if(task == null) throw new IllegalStateException("Action is missing");
|
if(task == null) throw new IllegalStateException("Action is missing");
|
||||||
task.withCallback(callback);
|
task.withCallback(callback);
|
||||||
return this;
|
return this;
|
||||||
|
|
Loading…
Reference in New Issue