Documenting code

mairbek · mairbek · commit db9f9a60afdf · 2013-03-19T20:09:36.000+02:00
diff --git a/rxjava-core/src/main/java/rx/Scheduler.java b/rxjava-core/src/main/java/rx/Scheduler.java
@@ -20,16 +20,46 @@
 
 import java.util.concurrent.TimeUnit;
 
+/**
+ * Represents an object that schedules units of work.
+ */
 public interface Scheduler {
 
-    Subscription schedule(Action0 action);
-
+    /**
+     * Schedules a cancelable action to be executed.
+     *
+     * @param action action
+     * @return a subscription to be able to unsubscribe from action.
+     */
     Subscription schedule(Func0<Subscription> action);
 
-    Subscription schedule(Action0 action, long timespan, TimeUnit unit);
+    /**
+     * Schedules an action to be executed.
+     *
+     * @param action action
+     * @return a subscription to be able to unsubscribe from action.
+     */
+    Subscription schedule(Action0 action);
+
+    /**
+     * Schedules an action to be executed in dueTime.
+     *
+     * @param action action
+     * @return a subscription to be able to unsubscribe from action.
+     */
+    Subscription schedule(Action0 action, long dueTime, TimeUnit unit);
 
-    Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit);
+    /**
+     * Schedules a cancelable action to be executed in dueTime.
+     *
+     * @param action action
+     * @return a subscription to be able to unsubscribe from action.
+     */
+    Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit);
 
+    /**
+     * Returns the scheduler's notion of current time.
+     */
     long now();
 
 }
diff --git a/rxjava-core/src/main/java/rx/concurrency/AbstractScheduler.java b/rxjava-core/src/main/java/rx/concurrency/AbstractScheduler.java
@@ -31,13 +31,13 @@ public Subscription schedule(Action0 action) {
     }
 
     @Override
-    public Subscription schedule(Action0 action, long timespan, TimeUnit unit) {
-        return schedule(asFunc0(action), timespan, unit);
+    public Subscription schedule(Action0 action, long dueTime, TimeUnit unit) {
+        return schedule(asFunc0(action), dueTime, unit);
     }
 
     @Override
-    public Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit) {
-        return schedule(new SleepingAction(action, this, timespan, unit));
+    public Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit) {
+        return schedule(new SleepingAction(action, this, dueTime, unit));
     }
 
     @Override
diff --git a/rxjava-core/src/main/java/rx/concurrency/ForwardingScheduler.java b/rxjava-core/src/main/java/rx/concurrency/ForwardingScheduler.java
@@ -40,13 +40,13 @@ public Subscription schedule(Func0<Subscription> action) {
     }
 
     @Override
-    public Subscription schedule(Action0 action, long timespan, TimeUnit unit) {
-        return underlying.schedule(action, timespan, unit);
+    public Subscription schedule(Action0 action, long dueTime, TimeUnit unit) {
+        return underlying.schedule(action, dueTime, unit);
     }
 
     @Override
-    public Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit) {
-        return underlying.schedule(action, timespan, unit);
+    public Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit) {
+        return underlying.schedule(action, dueTime, unit);
     }
 
     @Override
diff --git a/rxjava-core/src/main/java/rx/concurrency/ScheduledExecutorServiceScheduler.java b/rxjava-core/src/main/java/rx/concurrency/ScheduledExecutorServiceScheduler.java
@@ -34,14 +34,14 @@ public Subscription schedule(Func0<Subscription> action) {
     }
 
     @Override
-    public Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit) {
+    public Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit) {
         final DiscardableAction discardableAction = new DiscardableAction(action);
         executorService.schedule(new Runnable() {
             @Override
             public void run() {
                 discardableAction.call();
             }
-        }, timespan, unit);
+        }, dueTime, unit);
         return discardableAction;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -31,13 +31,13 @@ public Subscription schedule(Action0 action) {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- public Subscription schedule(Action0 action, long timespan, TimeUnit unit) {`
`35`		`- return schedule(asFunc0(action), timespan, unit);`
	`34`	`+ public Subscription schedule(Action0 action, long dueTime, TimeUnit unit) {`
	`35`	`+ return schedule(asFunc0(action), dueTime, unit);`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`@Override`
`39`		`- public Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit) {`
`40`		`- return schedule(new SleepingAction(action, this, timespan, unit));`
	`39`	`+ public Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit) {`
	`40`	`+ return schedule(new SleepingAction(action, this, dueTime, unit));`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -40,13 +40,13 @@ public Subscription schedule(Func0<Subscription> action) {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`@Override`
`43`		`- public Subscription schedule(Action0 action, long timespan, TimeUnit unit) {`
`44`		`- return underlying.schedule(action, timespan, unit);`
	`43`	`+ public Subscription schedule(Action0 action, long dueTime, TimeUnit unit) {`
	`44`	`+ return underlying.schedule(action, dueTime, unit);`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`
`48`		`- public Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit) {`
`49`		`- return underlying.schedule(action, timespan, unit);`
	`48`	`+ public Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit) {`
	`49`	`+ return underlying.schedule(action, dueTime, unit);`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -34,14 +34,14 @@ public Subscription schedule(Func0<Subscription> action) {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`@Override`
`37`		`- public Subscription schedule(Func0<Subscription> action, long timespan, TimeUnit unit) {`
	`37`	`+ public Subscription schedule(Func0<Subscription> action, long dueTime, TimeUnit unit) {`
`38`	`38`	`final DiscardableAction discardableAction = new DiscardableAction(action);`
`39`	`39`	`executorService.schedule(new Runnable() {`
`40`	`40`	`@Override`
`41`	`41`	`public void run() {`
`42`	`42`	`discardableAction.call();`
`43`	`43`	`}`
`44`		`- }, timespan, unit);`
	`44`	`+ }, dueTime, unit);`
`45`	`45`	`return discardableAction;`
`46`	`46`	`}`
`47`	`47`