Java Doc for ScheduledExecutorService.java in  » Apache-Harmony-Java-SE » java-package » java » util » concurrent » 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 » Apache Harmony Java SE » java package » java.util.concurrent 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.concurrent.ScheduledExecutorService

All known Subclasses:   java.util.concurrent.ScheduledThreadPoolExecutor,
ScheduledExecutorService
public interface ScheduledExecutorService extends ExecutorService(Code)
An ExecutorService that can schedule commands to run after a given delay, or to execute periodically.

The schedule methods create tasks with various delays and return a task object that can be used to cancel or check execution. The scheduleAtFixedRate and scheduleWithFixedDelay methods create and execute tasks that run periodically until cancelled.

Commands submitted using the Executor.execute and ExecutorService submit methods are scheduled with a requested delay of zero. Zero and negative delays (but not periods) are also allowed in schedule methods, and are treated as requests for immediate execution.

All schedule methods accept relative delays and periods as arguments, not absolute times or dates. It is a simple matter to transform an absolute time represented as a java.util.Date to the required form. For example, to schedule at a certain future date, you can use: schedule(task, date.getTime() - System.currentTimeMillis(), TimeUnit.MILLISECONDS). Beware however that expiration of a relative delay need not coincide with the current Date at which the task is enabled due to network time synchronization protocols, clock drift, or other factors. The Executors class provides convenient factory methods for the ScheduledExecutorService implementations provided in this package.

Usage Example

Here is a class with a method that sets up a ScheduledExecutorService to beep every ten seconds for an hour:
 import static java.util.concurrent.TimeUnit;
 class BeeperControl {
 private final ScheduledExecutorService scheduler = 
 Executors.newScheduledThreadPool(1);
 public void beepForAnHour() {
 final Runnable beeper = new Runnable() {
 public void run() { System.out.println("beep"); }
 };
 final ScheduledFuture<?> beeperHandle = 
 scheduler.scheduleAtFixedRate(beeper, 10, 10, SECONDS);
 scheduler.schedule(new Runnable() {
 public void run() { beeperHandle.cancel(true); }
 }, 60 * 60, SECONDS);
 }
 }
 

since:
   1.5
author:
   Doug Lea




Method Summary
public  ScheduledFutureschedule(Runnable command, long delay, TimeUnit unit)
     Creates and executes a one-shot action that becomes enabled after the given delay.
Parameters:
  command - the task to execute.
Parameters:
  delay - the time from now to delay execution.
Parameters:
  unit - the time unit of the delay parameter.
public  ScheduledFuture<V>schedule(Callable<V> callable, long delay, TimeUnit unit)
     Creates and executes a ScheduledFuture that becomes enabled after the given delay.
Parameters:
  callable - the function to execute.
Parameters:
  delay - the time from now to delay execution.
Parameters:
  unit - the time unit of the delay parameter.
public  ScheduledFuturescheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
     Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on.
public  ScheduledFuturescheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
     Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.



Method Detail
schedule
public ScheduledFuture schedule(Runnable command, long delay, TimeUnit unit)(Code)
Creates and executes a one-shot action that becomes enabled after the given delay.
Parameters:
  command - the task to execute.
Parameters:
  delay - the time from now to delay execution.
Parameters:
  unit - the time unit of the delay parameter. a Future representing pending completion of the task,and whose get() method will return nullupon completion.
throws:
  RejectedExecutionException - if task cannot be scheduledfor execution.
throws:
  NullPointerException - if command is null



schedule
public ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit)(Code)
Creates and executes a ScheduledFuture that becomes enabled after the given delay.
Parameters:
  callable - the function to execute.
Parameters:
  delay - the time from now to delay execution.
Parameters:
  unit - the time unit of the delay parameter. a ScheduledFuture that can be used to extract result or cancel.
throws:
  RejectedExecutionException - if task cannot be scheduledfor execution.
throws:
  NullPointerException - if callable is null



scheduleAtFixedRate
public ScheduledFuture scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)(Code)
Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor.
Parameters:
  command - the task to execute.
Parameters:
  initialDelay - the time to delay first execution.
Parameters:
  period - the period between successive executions.
Parameters:
  unit - the time unit of the initialDelay and period parameters a Future representing pending completion of the task,and whose get() method will throw an exception uponcancellation.
throws:
  RejectedExecutionException - if task cannot be scheduledfor execution.
throws:
  NullPointerException - if command is null
throws:
  IllegalArgumentException - if period less than or equal to zero.



scheduleWithFixedDelay
public ScheduledFuture scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)(Code)
Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor.
Parameters:
  command - the task to execute.
Parameters:
  initialDelay - the time to delay first execution.
Parameters:
  delay - the delay between the termination of oneexecution and the commencement of the next.
Parameters:
  unit - the time unit of the initialDelay and delay parameters a Future representing pending completion of the task,and whose get() method will throw an exception uponcancellation.
throws:
  RejectedExecutionException - if task cannot be scheduledfor execution.
throws:
  NullPointerException - if command is null
throws:
  IllegalArgumentException - if delay less than or equal to zero.



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