@@ -71,11 +71,12 @@ public abstract static class Worker implements Subscription {
71
71
72
72
/**
73
73
* Schedules an Action for execution at some point in the future.
74
- *
74
+ * <p>Note to implementors: non-positive {@code delayTime} should be regarded as
75
+ * undelayed schedule, i.e., as if the {@link #schedule(rx.functions.Action0)} was called.
75
76
* @param action
76
77
* the Action to schedule
77
78
* @param delayTime
78
- * time to wait before executing the action
79
+ * time to wait before executing the action, non-positive values indicate an undelayed schedule
79
80
* @param unit
80
81
* the time unit the delay time is given in
81
82
* @return a subscription to be able to unsubscribe the action (unschedule it if not executed)
@@ -86,13 +87,17 @@ public abstract static class Worker implements Subscription {
86
87
* Schedules a cancelable action to be executed periodically. This default implementation schedules
87
88
* recursively and waits for actions to complete (instead of potentially executing long-running actions
88
89
* concurrently). Each scheduler that can do periodic scheduling in a better way should override this.
90
+ * <p>Note to implementors: non-positive {@code initialTime} and {@code period} should be regarded as
91
+ * undelayed scheduling of the first and any subsequent executions.
89
92
*
90
93
* @param action
91
94
* the Action to execute periodically
92
95
* @param initialDelay
93
- * time to wait before executing the action for the first time
96
+ * time to wait before executing the action for the first time,
97
+ * non-positive values indicate an undelayed schedule
94
98
* @param period
95
- * the time interval to wait each time in between executing the action
99
+ * the time interval to wait each time in between executing the action,
100
+ * non-positive values indicate no delay between repeated schedules
96
101
* @param unit
97
102
* the time unit the interval above is given in
98
103
* @return a subscription to be able to unsubscribe the action (unschedule it if not executed)
0 commit comments