Java Doc for ScheduledThreadPoolExecutor.java in  » 6.0-JDK-Core » Collections-Jar-Zip-Logging-regex » java » util » concurrent » 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.concurrent 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.concurrent.AbstractExecutorService
      java.util.concurrent.ThreadPoolExecutor
         java.util.concurrent.ScheduledThreadPoolExecutor

ScheduledThreadPoolExecutor
public class ScheduledThreadPoolExecutor extends ThreadPoolExecutor implements ScheduledExecutorService(Code)



Constructor Summary
public  ScheduledThreadPoolExecutor(int corePoolSize)
     Creates a new ScheduledThreadPoolExecutor with the given core pool size.
public  ScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory threadFactory)
     Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
public  ScheduledThreadPoolExecutor(int corePoolSize, RejectedExecutionHandler handler)
     Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
public  ScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory threadFactory, RejectedExecutionHandler handler)
     Creates a new ScheduledThreadPoolExecutor with the given initial parameters.

Method Summary
 booleancanRunInCurrentRunState(boolean periodic)
     Returns true if can run a task given current run state and run-after-shutdown parameters.
protected  RunnableScheduledFuture<V>decorateTask(Runnable runnable, RunnableScheduledFuture<V> task)
     Modifies or replaces the task used to execute a runnable.
protected  RunnableScheduledFuture<V>decorateTask(Callable<V> callable, RunnableScheduledFuture<V> task)
     Modifies or replaces the task used to execute a callable.
public  voidexecute(Runnable command)
     Executes command with zero required delay. This has effect equivalent to ScheduledThreadPoolExecutor.schedule(Runnable,long,TimeUnit) schedule(command, 0, anyUnit) . Note that inspections of the queue and of the list returned by shutdownNow will access the zero-delayed ScheduledFuture , not the command itself.

A consequence of the use of ScheduledFuture objects is that ThreadPoolExecutor.afterExecute afterExecute is always called with a null second Throwable argument, even if the command terminated abruptly.

public  booleangetContinueExistingPeriodicTasksAfterShutdownPolicy()
     Gets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown .
public  booleangetExecuteExistingDelayedTasksAfterShutdownPolicy()
     Gets the policy on whether to execute existing delayed tasks even when this executor has been shutdown .
public  BlockingQueue<Runnable>getQueue()
     Returns the task queue used by this executor.
final  longnow()
     Returns current nanosecond time.
 voidonShutdown()
     Cancels and clears the queue of all tasks that should not be run due to shutdown policy.
 voidreExecutePeriodic(RunnableScheduledFuture task)
     Requeues a periodic task unless current run state precludes it.
public  ScheduledFutureschedule(Runnable command, long delay, TimeUnit unit)
    
public  ScheduledFuture<V>schedule(Callable<V> callable, long delay, TimeUnit unit)
    
public  ScheduledFuturescheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
    
public  ScheduledFuturescheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
    
public  voidsetContinueExistingPeriodicTasksAfterShutdownPolicy(boolean value)
     Sets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown .
public  voidsetExecuteExistingDelayedTasksAfterShutdownPolicy(boolean value)
     Sets the policy on whether to execute existing delayed tasks even when this executor has been shutdown .
public  voidshutdown()
     Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public  List<Runnable>shutdownNow()
     Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

There are no guarantees beyond best-effort attempts to stop processing actively executing tasks.

public  Futuresubmit(Runnable task)
    
public  Future<T>submit(Runnable task, T result)
    
public  Future<T>submit(Callable<T> task)
    


Constructor Detail
ScheduledThreadPoolExecutor
public ScheduledThreadPoolExecutor(int corePoolSize)(Code)
Creates a new ScheduledThreadPoolExecutor with the given core pool size.
Parameters:
  corePoolSize - the number of threads to keep in the pool, evenif they are idle, unless allowCoreThreadTimeOut is set
throws:
  IllegalArgumentException - if corePoolSize < 0



ScheduledThreadPoolExecutor
public ScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory threadFactory)(Code)
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
Parameters:
  corePoolSize - the number of threads to keep in the pool, evenif they are idle, unless allowCoreThreadTimeOut is set
Parameters:
  threadFactory - the factory to use when the executorcreates a new thread
throws:
  IllegalArgumentException - if corePoolSize < 0
throws:
  NullPointerException - if threadFactory is null



ScheduledThreadPoolExecutor
public ScheduledThreadPoolExecutor(int corePoolSize, RejectedExecutionHandler handler)(Code)
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
Parameters:
  corePoolSize - the number of threads to keep in the pool, evenif they are idle, unless allowCoreThreadTimeOut is set
Parameters:
  handler - the handler to use when execution is blockedbecause the thread bounds and queue capacities are reached
throws:
  IllegalArgumentException - if corePoolSize < 0
throws:
  NullPointerException - if handler is null



ScheduledThreadPoolExecutor
public ScheduledThreadPoolExecutor(int corePoolSize, ThreadFactory threadFactory, RejectedExecutionHandler handler)(Code)
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
Parameters:
  corePoolSize - the number of threads to keep in the pool, evenif they are idle, unless allowCoreThreadTimeOut is set
Parameters:
  threadFactory - the factory to use when the executorcreates a new thread
Parameters:
  handler - the handler to use when execution is blockedbecause the thread bounds and queue capacities are reached
throws:
  IllegalArgumentException - if corePoolSize < 0
throws:
  NullPointerException - if threadFactory or handler is null




Method Detail
canRunInCurrentRunState
boolean canRunInCurrentRunState(boolean periodic)(Code)
Returns true if can run a task given current run state and run-after-shutdown parameters.
Parameters:
  periodic - true if this task periodic, false if delayed



decorateTask
protected RunnableScheduledFuture<V> decorateTask(Runnable runnable, RunnableScheduledFuture<V> task)(Code)
Modifies or replaces the task used to execute a runnable. This method can be used to override the concrete class used for managing internal tasks. The default implementation simply returns the given task.
Parameters:
  runnable - the submitted Runnable
Parameters:
  task - the task created to execute the runnable a task that can execute the runnable
since:
   1.6



decorateTask
protected RunnableScheduledFuture<V> decorateTask(Callable<V> callable, RunnableScheduledFuture<V> task)(Code)
Modifies or replaces the task used to execute a callable. This method can be used to override the concrete class used for managing internal tasks. The default implementation simply returns the given task.
Parameters:
  callable - the submitted Callable
Parameters:
  task - the task created to execute the callable a task that can execute the callable
since:
   1.6



execute
public void execute(Runnable command)(Code)
Executes command with zero required delay. This has effect equivalent to ScheduledThreadPoolExecutor.schedule(Runnable,long,TimeUnit) schedule(command, 0, anyUnit) . Note that inspections of the queue and of the list returned by shutdownNow will access the zero-delayed ScheduledFuture , not the command itself.

A consequence of the use of ScheduledFuture objects is that ThreadPoolExecutor.afterExecute afterExecute is always called with a null second Throwable argument, even if the command terminated abruptly. Instead, the Throwable thrown by such a task can be obtained via Future.get .
throws:
  RejectedExecutionException - at discretion of RejectedExecutionHandler , if the taskcannot be accepted for execution because theexecutor has been shut down
throws:
  NullPointerException -




getContinueExistingPeriodicTasksAfterShutdownPolicy
public boolean getContinueExistingPeriodicTasksAfterShutdownPolicy()(Code)
Gets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown . In this case, these tasks will only terminate upon shutdownNow or after setting the policy to false when already shutdown. This value is by default false . true if will continue after shutdown
See Also:   ScheduledThreadPoolExecutor.setContinueExistingPeriodicTasksAfterShutdownPolicy



getExecuteExistingDelayedTasksAfterShutdownPolicy
public boolean getExecuteExistingDelayedTasksAfterShutdownPolicy()(Code)
Gets the policy on whether to execute existing delayed tasks even when this executor has been shutdown . In this case, these tasks will only terminate upon shutdownNow , or after setting the policy to false when already shutdown. This value is by default true . true if will execute after shutdown
See Also:   ScheduledThreadPoolExecutor.setExecuteExistingDelayedTasksAfterShutdownPolicy



getQueue
public BlockingQueue<Runnable> getQueue()(Code)
Returns the task queue used by this executor. Each element of this queue is a ScheduledFuture , including those tasks submitted using execute which are for scheduling purposes used as the basis of a zero-delay ScheduledFuture . Iteration over this queue is not guaranteed to traverse tasks in the order in which they will execute. the task queue



now
final long now()(Code)
Returns current nanosecond time.



onShutdown
void onShutdown()(Code)
Cancels and clears the queue of all tasks that should not be run due to shutdown policy. Invoked within super.shutdown.



reExecutePeriodic
void reExecutePeriodic(RunnableScheduledFuture task)(Code)
Requeues a periodic task unless current run state precludes it. Same idea as delayedExecute except drops task rather than rejecting.
Parameters:
  task - the task



schedule
public ScheduledFuture schedule(Runnable command, long delay, TimeUnit unit)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -



schedule
public ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -



scheduleAtFixedRate
public ScheduledFuture scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -
throws:
  IllegalArgumentException -



scheduleWithFixedDelay
public ScheduledFuture scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -
throws:
  IllegalArgumentException -



setContinueExistingPeriodicTasksAfterShutdownPolicy
public void setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean value)(Code)
Sets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown . In this case, these tasks will only terminate upon shutdownNow or after setting the policy to false when already shutdown. This value is by default false .
Parameters:
  value - if true , continue after shutdown, else don't.
See Also:   ScheduledThreadPoolExecutor.getContinueExistingPeriodicTasksAfterShutdownPolicy



setExecuteExistingDelayedTasksAfterShutdownPolicy
public void setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean value)(Code)
Sets the policy on whether to execute existing delayed tasks even when this executor has been shutdown . In this case, these tasks will only terminate upon shutdownNow , or after setting the policy to false when already shutdown. This value is by default true .
Parameters:
  value - if true , execute after shutdown, else don't.
See Also:   ScheduledThreadPoolExecutor.getExecuteExistingDelayedTasksAfterShutdownPolicy



shutdown
public void shutdown()(Code)
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. If the ExecuteExistingDelayedTasksAfterShutdownPolicy has been set false , existing delayed tasks whose delays have not yet elapsed are cancelled. And unless the ContinueExistingPeriodicTasksAfterShutdownPolicy has been set true , future executions of existing periodic tasks will be cancelled.
throws:
  SecurityException -



shutdownNow
public List<Runnable> shutdownNow()(Code)
Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. This implementation cancels tasks via Thread.interrupt , so any task that fails to respond to interrupts may never terminate. list of tasks that never commenced execution.Each element of this list is a ScheduledFuture,including those tasks submitted using execute ,which are for scheduling purposes used as the basis of azero-delay ScheduledFuture .
throws:
  SecurityException -




submit
public Future submit(Runnable task)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -



submit
public Future<T> submit(Runnable task, T result)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -



submit
public Future<T> submit(Callable<T> task)(Code)

throws:
  RejectedExecutionException -
throws:
  NullPointerException -



Methods inherited from java.util.concurrent.ThreadPoolExecutor
protected void afterExecute(Runnable r, Throwable t)(Code)(Java Doc)
public void allowCoreThreadTimeOut(boolean value)(Code)(Java Doc)
public boolean allowsCoreThreadTimeOut()(Code)(Java Doc)
public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException(Code)(Java Doc)
protected void beforeExecute(Thread t, Runnable r)(Code)(Java Doc)
public void execute(Runnable command)(Code)(Java Doc)
protected void finalize()(Code)(Java Doc)
public int getActiveCount()(Code)(Java Doc)
public long getCompletedTaskCount()(Code)(Java Doc)
public int getCorePoolSize()(Code)(Java Doc)
public long getKeepAliveTime(TimeUnit unit)(Code)(Java Doc)
public int getLargestPoolSize()(Code)(Java Doc)
public int getMaximumPoolSize()(Code)(Java Doc)
public int getPoolSize()(Code)(Java Doc)
public BlockingQueue<Runnable> getQueue()(Code)(Java Doc)
public RejectedExecutionHandler getRejectedExecutionHandler()(Code)(Java Doc)
public long getTaskCount()(Code)(Java Doc)
public ThreadFactory getThreadFactory()(Code)(Java Doc)
final boolean isRunningOrShutdown(boolean shutdownOK)(Code)(Java Doc)
public boolean isShutdown()(Code)(Java Doc)
public boolean isTerminated()(Code)(Java Doc)
public boolean isTerminating()(Code)(Java Doc)
void onShutdown()(Code)(Java Doc)
public int prestartAllCoreThreads()(Code)(Java Doc)
public boolean prestartCoreThread()(Code)(Java Doc)
public void purge()(Code)(Java Doc)
final void reject(Runnable command)(Code)(Java Doc)
public boolean remove(Runnable task)(Code)(Java Doc)
final void runWorker(Worker w)(Code)(Java Doc)
public void setCorePoolSize(int corePoolSize)(Code)(Java Doc)
public void setKeepAliveTime(long time, TimeUnit unit)(Code)(Java Doc)
public void setMaximumPoolSize(int maximumPoolSize)(Code)(Java Doc)
public void setRejectedExecutionHandler(RejectedExecutionHandler handler)(Code)(Java Doc)
public void setThreadFactory(ThreadFactory threadFactory)(Code)(Java Doc)
public void shutdown()(Code)(Java Doc)
public List<Runnable> shutdownNow()(Code)(Java Doc)
protected void terminated()(Code)(Java Doc)
final void tryTerminate()(Code)(Java Doc)

Methods inherited from java.util.concurrent.AbstractExecutorService
public List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException(Code)(Java Doc)
public List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException(Code)(Java Doc)
public T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException(Code)(Java Doc)
public T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException(Code)(Java Doc)
protected RunnableFuture<T> newTaskFor(Runnable runnable, T value)(Code)(Java Doc)
protected RunnableFuture<T> newTaskFor(Callable<T> callable)(Code)(Java Doc)
public Future submit(Runnable task)(Code)(Java Doc)
public Future<T> submit(Runnable task, T result)(Code)(Java Doc)
public Future<T> submit(Callable<T> task)(Code)(Java Doc)

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.