org.iota.jota.utils.thread

Interface SilentScheduledExecutorService

All Superinterfaces:

Executor, ExecutorService, ScheduledExecutorService

All Known Implementing Classes:

BoundedScheduledExecutorService, DedicatedScheduledExecutorService

public interface SilentScheduledExecutorService
extends ScheduledExecutorService

This interface extends the ScheduledExecutorService by providing additional methods to enqueue tasks without throwing a RejectedExecutionException exception.

This can be useful when preventing additional tasks to run is no error but an intended design decision in the implementing class. In these cases raising an exception and catching it would cause too much unnecessary overhead (using Exceptions for control flow is an anti pattern).

Method Summary

Modifier and Type	Method and Description
void	silentExecute(Runnable command) Does the same as Executor.execute(Runnable) but doesn't throw a RejectedExecutionException if this task cannot be accepted for execution.
<T> List<Future<T>>	silentInvokeAll(Collection<? extends Callable<T>> tasks) Does the same as ExecutorService.invokeAll(Collection) but returns null instead of throwing a RejectedExecutionException if any task cannot be scheduled for execution.
<T> List<Future<T>>	silentInvokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) Does the same as ExecutorService.invokeAll(Collection, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if any task cannot be scheduled for execution.
<T> T	silentInvokeAny(Collection<? extends Callable<T>> tasks) Does the same as ExecutorService.invokeAny(Collection) but returns null instead of throwing a RejectedExecutionException if tasks cannot be scheduled for execution.
<T> T	silentInvokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) Does the same as ExecutorService.invokeAny(Collection, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if tasks cannot be scheduled for execution.
<V> ScheduledFuture<V>	silentSchedule(Callable<V> callable, long delay, TimeUnit unit) Does the same as ScheduledExecutorService.schedule(Callable, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.
ScheduledFuture<?>	silentSchedule(Runnable command, long delay, TimeUnit unit) Does the same as ScheduledExecutorService.schedule(Runnable, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.
ScheduledFuture<?>	silentScheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) Does the same as ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.
ScheduledFuture<?>	silentScheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) Does the same as ScheduledExecutorService.scheduleWithFixedDelay(Runnable, long, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.
<T> Future<T>	silentSubmit(Callable<T> task) Does the same as ExecutorService.submit(Callable) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.
Future<?>	silentSubmit(Runnable task) Does the same as ExecutorService.submit(Runnable) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.
<T> Future<T>	silentSubmit(Runnable task, T result) Does the same as ExecutorService.submit(Runnable, Object) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Methods inherited from interface java.util.concurrent.ScheduledExecutorService

schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit

Methods inherited from interface java.util.concurrent.Executor

execute

Method Detail

silentSchedule

ScheduledFuture<?> silentSchedule(Runnable command,
                                  long delay,
                                  TimeUnit unit)

Does the same as ScheduledExecutorService.schedule(Runnable, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Parameters:

command - the task to execute

delay - the time from now to delay execution

unit - the time unit of the delay parameter

Returns:

a ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if command is null

silentSchedule

<V> ScheduledFuture<V> silentSchedule(Callable<V> callable,
                                      long delay,
                                      TimeUnit unit)

Does the same as ScheduledExecutorService.schedule(Callable, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Type Parameters:

V - the type of the callable's result

Parameters:

callable - the function to execute

delay - the time from now to delay execution

unit - the time unit of the delay parameter

Returns:

a ScheduledFuture that can be used to extract result or cancel / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if callable is null

silentScheduleAtFixedRate

ScheduledFuture<?> silentScheduleAtFixedRate(Runnable command,
                                             long initialDelay,
                                             long period,
                                             TimeUnit unit)

Does the same as ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Parameters:

command - the task to execute

initialDelay - the time to delay first execution

period - the period between successive executions

unit - the time unit of the initialDelay and period parameters

Returns:

a ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if command is null

IllegalArgumentException - if period less than or equal to zero

silentScheduleWithFixedDelay

ScheduledFuture<?> silentScheduleWithFixedDelay(Runnable command,
                                                long initialDelay,
                                                long delay,
                                                TimeUnit unit)

Does the same as ScheduledExecutorService.scheduleWithFixedDelay(Runnable, long, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Parameters:

command - the task to execute

initialDelay - the time to delay first execution

delay - the delay between the termination of one execution and the commencement of the next

unit - the time unit of the initialDelay and delay parameters

Returns:

a ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if command is null

IllegalArgumentException - if delay less than or equal to zero

silentSubmit

<T> Future<T> silentSubmit(Callable<T> task)

Does the same as ExecutorService.submit(Callable) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

Returns:

a Future representing pending completion of the task / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if the task is null

silentSubmit

Future<?> silentSubmit(Runnable task)

Does the same as ExecutorService.submit(Runnable) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Parameters:

task - the task to submit

Returns:

a Future representing pending completion of the task / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if the task is null

silentSubmit

<T> Future<T> silentSubmit(Runnable task,
                           T result)

Does the same as ExecutorService.submit(Runnable, Object) but returns null instead of throwing a RejectedExecutionException if the task cannot be scheduled for execution.

Type Parameters:

T - the type of the result

Parameters:

task - the task to submit

result - the result to return

Returns:

a Future representing pending completion of the task / null if the task cannot be scheduled for execution

Throws:

NullPointerException - if the task is null

silentInvokeAll

<T> List<Future<T>> silentInvokeAll(Collection<? extends Callable<T>> tasks)
                             throws InterruptedException

Does the same as ExecutorService.invokeAll(Collection) but returns null instead of throwing a RejectedExecutionException if any task cannot be scheduled for execution.

Type Parameters:

T - the type of the values returned from the tasks

Parameters:

tasks - the collection of tasks

Returns:

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed / null if any task cannot be scheduled for execution

Throws:

InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled

NullPointerException - if tasks or any of its elements are null

silentInvokeAll

<T> List<Future<T>> silentInvokeAll(Collection<? extends Callable<T>> tasks,
                                    long timeout,
                                    TimeUnit unit)
                             throws InterruptedException

Does the same as ExecutorService.invokeAll(Collection, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if any task cannot be scheduled for execution.

Type Parameters:

T - the type of the values returned from the tasks

Parameters:

tasks - the collection of tasks

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

a list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed. It returns null if any task cannot be scheduled for execution.

Throws:

InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled

NullPointerException - if tasks, any of its elements, or unit are null

silentInvokeAny

<T> T silentInvokeAny(Collection<? extends Callable<T>> tasks)
               throws InterruptedException,
                      ExecutionException

Does the same as ExecutorService.invokeAny(Collection) but returns null instead of throwing a RejectedExecutionException if tasks cannot be scheduled for execution.

Type Parameters:

T - the type of the values returned from the tasks

Parameters:

tasks - the collection of tasks

Returns:

the result returned by one of the tasks or null if tasks cannot be scheduled for execution

Throws:

InterruptedException - if interrupted while waiting

NullPointerException - if tasks or any element task subject to execution is null

IllegalArgumentException - if tasks is empty

ExecutionException - if no task successfully completes

silentInvokeAny

<T> T silentInvokeAny(Collection<? extends Callable<T>> tasks,
                      long timeout,
                      TimeUnit unit)
               throws InterruptedException,
                      ExecutionException,
                      TimeoutException

Does the same as ExecutorService.invokeAny(Collection, long, TimeUnit) but returns null instead of throwing a RejectedExecutionException if tasks cannot be scheduled for execution.

Type Parameters:

T - the type of the values returned from the tasks

Parameters:

tasks - the collection of tasks

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the result returned by one of the tasks or null if tasks cannot be scheduled for execution

Throws:

InterruptedException - if interrupted while waiting

NullPointerException - if tasks, or unit, or any element task subject to execution is null

TimeoutException - if the given timeout elapses before any task successfully completes

ExecutionException - if no task successfully completes

silentExecute

void silentExecute(Runnable command)

Does the same as Executor.execute(Runnable) but doesn't throw a RejectedExecutionException if this task cannot be accepted for execution.

Parameters:

command - the runnable task

Throws:

NullPointerException - if command is null