Java Doc for Timer.java in  » 6.0-JDK-Modules » j2me » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.Timer

All known Subclasses:   com.sun.midp.suspend.SuspendTimer,
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.

Timers function only within a single VM and are cancelled when the VM exits. When the VM is started no timers exist, they are created only by application request.
See Also:   TimerTask
See Also:   Object.wait(long)
since:
   1.3




Constructor Summary
public  Timer()
     Creates a new timer.

Method Summary
public  voidcancel()
     Terminates this timer, discarding any currently scheduled tasks.
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 run as a daemon thread, which may prevent an application from terminating.
See Also:   Thread
See Also:   Timer.cancel()




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.




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, or timer was cancelled.



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 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 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).

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 time.getTime() is negative.
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 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 is negative, ordelay + System.currentTimeMillis() is negative.
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).

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 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 time.getTime() is negative.
throws:
  IllegalStateException - if task was already scheduled orcancelled, timer was cancelled, or timer thread terminated.




Methods inherited from java.lang.Object
public boolean equals(Object obj)(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.