Skip to content

Commit 5ee45eb

Browse files
committed
jector: fixed javadoc
* modified: jector-monkey/src/main/java/com/avrsandbox/jector/monkey/core/work/MonkeyWorkerTask.java * modified: jector/src/main/java/com/avrsandbox/jector/core/work/TaskExecutorsManager.java * modified: jector/src/main/java/com/avrsandbox/jector/core/work/WorkerTask.java * modified: jector/src/main/java/com/avrsandbox/jector/util/Tasks.java
1 parent 19c85f4 commit 5ee45eb

File tree

4 files changed

+19
-2
lines changed

4 files changed

+19
-2
lines changed

jector-monkey/src/main/java/com/avrsandbox/jector/monkey/core/work/MonkeyWorkerTask.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ public abstract class MonkeyWorkerTask extends WorkerTask {
4747
*/
4848
protected float timePerFrame;
4949

50+
/**
51+
* Instantiates a JME worker task mapping a method to be executed
52+
* on the JME-3 Main thread.
53+
*/
54+
public MonkeyWorkerTask() {
55+
super();
56+
}
57+
5058
/**
5159
* Updates the time-per-frame value (in seconds).
5260
*

jector/src/main/java/com/avrsandbox/jector/core/work/TaskExecutorsManager.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ protected void bind(Class<? extends TaskExecutor>[] clazzes, Worker worker, Meth
208208
* Binds a method to a task executor instance by wrapping it into a {@link WorkerTask}.
209209
*
210210
* @param taskExecutor the executor instance
211+
* @param worker the worker class containing the runnable annotated methods
211212
* @param method the method to wrap as a task
212213
* @param args the method arguments, or null for nullary methods
213214
*/
@@ -230,7 +231,8 @@ public Object call() {
230231
/**
231232
* Executes a method passing in its arguments object and the binder object,
232233
* the signature of the parameterized methods must be [Object method(MethodArguments, TaskBinder)].
233-
*
234+
*
235+
* @param worker the worker class containing the runnable annotated methods
234236
* @param method the method to execute, should be of the signature
235237
* [Object method(MethodArguments, TaskBinder)]
236238
* @param args the method arguments data structure

jector/src/main/java/com/avrsandbox/jector/core/work/WorkerTask.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
/**
3737
* Defines a task for a worker object, a task maps a method to be
38-
* executed in the annotated {@link TaskExecutor}.
38+
* executed with the annotated {@link TaskExecutor}.
3939
*
4040
* @author pavl_g
4141
*/
@@ -52,6 +52,12 @@ public abstract class WorkerTask implements Callable<Object> {
5252
*/
5353
protected volatile Object result;
5454

55+
/**
56+
* Instantiates a worker task mapping a method to be executed.
57+
*/
58+
public WorkerTask() {
59+
}
60+
5561
/**
5662
* Sets the return result of this task, "null" if a task to a void
5763
* method is specified.

jector/src/main/java/com/avrsandbox/jector/util/Tasks.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ public static WorkerTask getWorkerTask(TaskExecutorsManager taskExecutorsManager
7979
* Retrieves a worker task return value from its task executor object (which is registered to
8080
* a task binder).
8181
*
82+
* @param <T> a method generic to avoid further dynamic casting
8283
* @param taskExecutorsManager the manager instance holding the TaskExecutors
8384
* @param clazz the represented executor holding the task to retrieve
8485
* @param name the name of the task to retrieve (usually the name of the worker method)

0 commit comments

Comments
 (0)