You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by dg...@apache.org on 2018/10/19 10:02:47 UTC

incubator-unomi git commit: UNOMI-202 add javadoc

Repository: incubator-unomi
Updated Branches:
  refs/heads/master 12f0cabcb -> 3bb183f75


UNOMI-202 add javadoc


Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/3bb183f7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/3bb183f7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/3bb183f7

Branch: refs/heads/master
Commit: 3bb183f75bca928a7db7c18aafd2e4ef3089e4ac
Parents: 12f0cab
Author: dgaillard <dg...@jahia.com>
Authored: Fri Oct 19 12:02:39 2018 +0200
Committer: dgaillard <dg...@jahia.com>
Committed: Fri Oct 19 12:02:39 2018 +0200

----------------------------------------------------------------------
 .../org/apache/unomi/api/services/SchedulerService.java | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/3bb183f7/api/src/main/java/org/apache/unomi/api/services/SchedulerService.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/unomi/api/services/SchedulerService.java b/api/src/main/java/org/apache/unomi/api/services/SchedulerService.java
index ddf2cd2..e9d6900 100644
--- a/api/src/main/java/org/apache/unomi/api/services/SchedulerService.java
+++ b/api/src/main/java/org/apache/unomi/api/services/SchedulerService.java
@@ -20,8 +20,18 @@ package org.apache.unomi.api.services;
 import java.util.concurrent.ScheduledExecutorService;
 
 /**
- * @author dgaillard
+ * A service to access {@link ScheduledExecutorService} to execute {@link java.util.TimerTask}
+ * Use this service instead of creating and using a new {@link java.util.Timer}
+ *
+ * https://stackoverflow.com/questions/409932/java-timer-vs-executorservice
  */
 public interface SchedulerService {
+
+    /**
+     * Use this method to get a {@link ScheduledExecutorService}
+     * and execute your task with it instead of using {@link java.util.Timer}
+     *
+     * @return {@link ScheduledExecutorService}
+     */
     ScheduledExecutorService getScheduleExecutorService();
 }