Java Doc for Timer.java in  » 6.0-JDK-Core » Collections-Jar-Zip-Logging-regex » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Collections Jar Zip Logging regex » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.Timer

Timer
public class Timer (Code)
A facility for threads to schedule tasks for future execution in a background thread. Tasks may be scheduled for one-time execution, or for repeated execution at regular intervals.

Corresponding to each Timer object is a single background thread that is used to execute all of the timer's tasks, sequentially. Timer tasks should complete quickly. If a timer task takes excessive time to complete, it "hogs" the timer's task execution thread. This can, in turn, delay the execution of subsequent tasks, which may "bunch up" and execute in rapid succession when (and if) the offending task finally completes.

After the last live reference to a Timer object goes away and all outstanding tasks have completed execution, the timer's task execution thread terminates gracefully (and becomes subject to garbage collection). However, this can take arbitrarily long to occur. By default, the task execution thread does not run as a daemon thread, so it is capable of keeping an application from terminating. If a caller wants to terminate a timer's task execution thread rapidly, the caller should invoke the timer's cancel method.

If the timer's task execution thread terminates unexpectedly, for example, because its stop method is invoked, any further attempt to schedule a task on the timer will result in an IllegalStateException, as if the timer's cancel method had been invoked.

This class is thread-safe: multiple threads can share a single Timer object without the need for external synchronization.

This class does not offer real-time guarantees: it schedules tasks using the Object.wait(long) method.

Java 5.0 introduced the java.util.concurrent package and one of the concurrency utilities therein is the java.util.concurrent.ScheduledThreadPoolExecutorScheduledThreadPoolExecutor which is a thread pool for repeatedly executing tasks at a given rate or delay. It is effectively a more versatile replacement for the Timer / TimerTask combination, as it allows multiple service threads, accepts various time units, and doesn't require subclassing TimerTask (just implement Runnable ). Configuring ScheduledThreadPoolExecutor with one thread makes it equivalent to Timer .

Implementation note: This class scales to large numbers of concurrently scheduled tasks (thousands should present no problem). Internally, it uses a binary heap to represent its task queue, so the cost to schedule a task is O(log n), where n is the number of concurrently scheduled tasks.

Implementation note: All constructors start a timer thread.
author:
   Josh Bloch
version:
   1.28, 06/27/07
See Also:   TimerTask
See Also:   Object.wait(long)
since:
   1.3




Constructor Summary
public  Timer()
     Creates a new timer.
public  Timer(boolean isDaemon)
     Creates a new timer whose associated thread may be specified to .
public  Timer(String name)
     Creates a new timer whose associated thread has the specified name.
public  Timer(String name, boolean isDaemon)
     Creates a new timer whose associated thread has the specified name, and may be specified to .

Method Summary
public  voidcancel()
     Terminates this timer, discarding any currently scheduled tasks.
public  intpurge()
     Removes all cancelled tasks from this timer's task queue.
public  voidschedule(TimerTask task, long delay)
     Schedules the specified task for execution after the specified delay.
public  voidschedule(TimerTask task, Date time)
     Schedules the specified task for execution at the specified time.
public  voidschedule(TimerTask task, long delay, long period)
     Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay.
public  voidschedule(TimerTask task, Date firstTime, long period)
     Schedules the specified task for repeated fixed-delay execution, beginning at the specified time.
public  voidscheduleAtFixedRate(TimerTask task, long delay, long period)
     Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay.
public  voidscheduleAtFixedRate(TimerTask task, Date firstTime, long period)
     Schedules the specified task for repeated fixed-rate execution, beginning at the specified time.


Constructor Detail
Timer
public Timer()(Code)
Creates a new timer. The associated thread does not .



Timer
public Timer(boolean isDaemon)(Code)
Creates a new timer whose associated thread may be specified to . A daemon thread is called for if the timer will be used to schedule repeating "maintenance activities", which must be performed as long as the application is running, but should not prolong the lifetime of the application.
Parameters:
  isDaemon - true if the associated thread should run as a daemon.



Timer
public Timer(String name)(Code)
Creates a new timer whose associated thread has the specified name. The associated thread does not .
Parameters:
  name - the name of the associated thread
throws:
  NullPointerException - if name is null
since:
   1.5



Timer
public Timer(String name, boolean isDaemon)(Code)
Creates a new timer whose associated thread has the specified name, and may be specified to .
Parameters:
  name - the name of the associated thread
Parameters:
  isDaemon - true if the associated thread should run as a daemon
throws:
  NullPointerException - if name is null
since:
   1.5




Method Detail
cancel
public void cancel()(Code)
Terminates this timer, discarding any currently scheduled tasks. Does not interfere with a currently executing task (if it exists). Once a timer has been terminated, its execution thread terminates gracefully, and no more tasks may be scheduled on it.

Note that calling this method from within the run method of a timer task that was invoked by this timer absolutely guarantees that the ongoing task execution is the last task execution that will ever be performed by this timer.

This method may be called repeatedly; the second and subsequent calls have no effect.




purge
public int purge()(Code)
Removes all cancelled tasks from this timer's task queue. Calling this method has no effect on the behavior of the timer, but eliminates the references to the cancelled tasks from the queue. If there are no external references to these tasks, they become eligible for garbage collection.

Most programs will have no need to call this method. It is designed for use by the rare application that cancels a large number of tasks. Calling this method trades time for space: the runtime of the method may be proportional to n + c log n, where n is the number of tasks in the queue and c is the number of cancelled tasks.

Note that it is permissible to call this method from within a a task scheduled on this timer. the number of tasks removed from the queue.
since:
   1.5




schedule
public void schedule(TimerTask task, long delay)(Code)
Schedules the specified task for execution after the specified delay.
Parameters:
  task - task to be scheduled.
Parameters:
  delay - delay in milliseconds before task is to be executed.
throws:
  IllegalArgumentException - if delay is negative, ordelay + System.currentTimeMillis() is negative.
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.



schedule
public void schedule(TimerTask task, Date time)(Code)
Schedules the specified task for execution at the specified time. If the time is in the past, the task is scheduled for immediate execution.
Parameters:
  task - task to be scheduled.
Parameters:
  time - time at which task is to be executed.
throws:
  IllegalArgumentException - if time.getTime() is negative.
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.



schedule
public void schedule(TimerTask task, long delay, long period)(Code)
Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals separated by the specified period.

In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate).

Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.
Parameters:
  task - task to be scheduled.
Parameters:
  delay - delay in milliseconds before task is to be executed.
Parameters:
  period - time in milliseconds between successive task executions.
throws:
  IllegalArgumentException - if delay < 0 , or delay + System.currentTimeMillis() < 0 , or period <= 0
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.




schedule
public void schedule(TimerTask task, Date firstTime, long period)(Code)
Schedules the specified task for repeated fixed-delay execution, beginning at the specified time. Subsequent executions take place at approximately regular intervals, separated by the specified period.

In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate). As a consequence of the above, if the scheduled first time is in the past, it is scheduled for immediate execution.

Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.
Parameters:
  task - task to be scheduled.
Parameters:
  firstTime - First time at which task is to be executed.
Parameters:
  period - time in milliseconds between successive task executions.
throws:
  IllegalArgumentException - if firstTime.getTime() < 0 , or period <= 0
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.




scheduleAtFixedRate
public void scheduleAtFixedRate(TimerTask task, long delay, long period)(Code)
Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals, separated by the specified period.

In fixed-rate execution, each execution is scheduled relative to the scheduled execution time of the initial execution. If an execution is delayed for any reason (such as garbage collection or other background activity), two or more executions will occur in rapid succession to "catch up." In the long run, the frequency of execution will be exactly the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate).

Fixed-rate execution is appropriate for recurring activities that are sensitive to absolute time, such as ringing a chime every hour on the hour, or running scheduled maintenance every day at a particular time. It is also appropriate for recurring activities where the total time to perform a fixed number of executions is important, such as a countdown timer that ticks once every second for ten seconds. Finally, fixed-rate execution is appropriate for scheduling multiple repeating timer tasks that must remain synchronized with respect to one another.
Parameters:
  task - task to be scheduled.
Parameters:
  delay - delay in milliseconds before task is to be executed.
Parameters:
  period - time in milliseconds between successive task executions.
throws:
  IllegalArgumentException - if delay < 0 , or delay + System.currentTimeMillis() < 0 , or period <= 0
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.




scheduleAtFixedRate
public void scheduleAtFixedRate(TimerTask task, Date firstTime, long period)(Code)
Schedules the specified task for repeated fixed-rate execution, beginning at the specified time. Subsequent executions take place at approximately regular intervals, separated by the specified period.

In fixed-rate execution, each execution is scheduled relative to the scheduled execution time of the initial execution. If an execution is delayed for any reason (such as garbage collection or other background activity), two or more executions will occur in rapid succession to "catch up." In the long run, the frequency of execution will be exactly the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate). As a consequence of the above, if the scheduled first time is in the past, then any "missed" executions will be scheduled for immediate "catch up" execution.

Fixed-rate execution is appropriate for recurring activities that are sensitive to absolute time, such as ringing a chime every hour on the hour, or running scheduled maintenance every day at a particular time. It is also appropriate for recurring activities where the total time to perform a fixed number of executions is important, such as a countdown timer that ticks once every second for ten seconds. Finally, fixed-rate execution is appropriate for scheduling multiple repeating timer tasks that must remain synchronized with respect to one another.
Parameters:
  task - task to be scheduled.
Parameters:
  firstTime - First time at which task is to be executed.
Parameters:
  period - time in milliseconds between successive task executions.
throws:
  IllegalArgumentException - if firstTime.getTime() < 0 or period <= 0
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.