TimerTask.ScheduledExecutionTime Method

[Android.Runtime.Register("scheduledExecutionTime", "()J", "GetScheduledExecutionTimeHandler")]
public virtual long ScheduledExecutionTime ();

[<Android.Runtime.Register("scheduledExecutionTime", "()J", "GetScheduledExecutionTimeHandler")>]
abstract member ScheduledExecutionTime : unit -> int64
override this.ScheduledExecutionTime : unit -> int64

Returns

the time at which the most recent execution of this task was scheduled to occur, in the format returned by Date.getTime(). The return value is undefined if the task has yet to commence its first execution.

Attributes

RegisterAttribute

Remarks

Returns the scheduled execution time of the most recent actual execution of this task. (If this method is invoked while task execution is in progress, the return value is the scheduled execution time of the ongoing task execution.)

This method is typically invoked from within a task's run method, to determine whether the current execution of the task is sufficiently timely to warrant performing the scheduled activity:

{@code
              public void run() {
                  if (System.currentTimeMillis() - scheduledExecutionTime() >=
                      MAX_TARDINESS)
                          return;  // Too late; skip this execution.
                  // Perform the task
              }
            }

This method is typically not used in conjunction with fixed-delay execution repeating tasks, as their scheduled execution times are allowed to drift over time, and so are not terribly significant.

Java documentation for java.util.TimerTask.scheduledExecutionTime().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to