org.jgroups.util
Class MockTimeScheduler

java.lang.Object
  org.jgroups.util.MockTimeScheduler

All Implemented Interfaces:

TimeScheduler

public class MockTimeScheduler
extends java.lang.Object
implements TimeScheduler

Mock implementation of TimeScheduler, used by unit tests

Since:

3.0

Author:

Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgroups.util.TimeScheduler

TimeScheduler.Task

Constructor Summary

MockTimeScheduler()

Method Summary

java.lang.String	dumpTimerTasks() Returns a list of tasks currently waiting for execution.
void	execute(java.lang.Runnable command) Executes command with zero required delay.
int	getCurrentThreads() Returns the current threads in the pool, or -1 if not applicable
long	getKeepAliveTime() Returns the keep alive time (in ms) of the thread pool, or -1 if not applicable
int	getMaxThreads() Returns the configured max threads, or -1 if not applicable
int	getMinThreads() Returns the configured core threads, or -1 if not applicable
boolean	isShutdown() Returns true if stop() has been called, false otherwise
java.util.concurrent.Future<?>	schedule(java.lang.Runnable command, long delay, java.util.concurrent.TimeUnit unit) Creates and executes a one-shot action that becomes enabled after the given delay.
java.util.concurrent.Future<?>	scheduleAtFixedRate(java.lang.Runnable command, long initialDelay, long period, java.util.concurrent.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.
java.util.concurrent.Future<?>	scheduleWithDynamicInterval(TimeScheduler.Task task) Schedule a task for execution at varying intervals.
java.util.concurrent.Future<?>	scheduleWithFixedDelay(java.lang.Runnable command, long initialDelay, long delay, java.util.concurrent.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.
void	setKeepAliveTime(long time) Sets the keep alive time (in ms) of the thread pool.
void	setMaxThreads(int size) Sets the max pool size.
void	setMinThreads(int size) Sets the core pool size.
void	setThreadFactory(ThreadFactory factory)
int	size() Returns the number of tasks currently in the queue.
void	stop() Stops the scheduler if running, cancelling all pending tasks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockTimeScheduler

public MockTimeScheduler()

Method Detail

execute

public void execute(java.lang.Runnable command)

Description copied from interface: TimeScheduler

Executes command with zero required delay. This has effect equivalent to schedule(command, 0, anyUnit).

Specified by:

execute in interface TimeScheduler

Parameters:

command - the task to execute

schedule

public java.util.concurrent.Future<?> schedule(java.lang.Runnable command,
                                               long delay,
                                               java.util.concurrent.TimeUnit unit)

Description copied from interface: TimeScheduler

Creates and executes a one-shot action that becomes enabled after the given delay.

Specified by:

schedule in interface TimeScheduler

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

scheduleWithFixedDelay

public java.util.concurrent.Future<?> scheduleWithFixedDelay(java.lang.Runnable command,
                                                             long initialDelay,
                                                             long delay,
                                                             java.util.concurrent.TimeUnit unit)

Description copied from interface: TimeScheduler

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.

Specified by:

scheduleWithFixedDelay in interface TimeScheduler

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

scheduleAtFixedRate

public java.util.concurrent.Future<?> scheduleAtFixedRate(java.lang.Runnable command,
                                                          long initialDelay,
                                                          long period,
                                                          java.util.concurrent.TimeUnit unit)

Description copied from interface: TimeScheduler

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. If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.

Specified by:

scheduleAtFixedRate in interface TimeScheduler

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

scheduleWithDynamicInterval

public java.util.concurrent.Future<?> scheduleWithDynamicInterval(TimeScheduler.Task task)

Description copied from interface: TimeScheduler

Schedule a task for execution at varying intervals. After execution, the task will get rescheduled after TimeScheduler.Task.nextInterval() milliseconds. The task is never done until nextInterval() return a value <= 0 or the task is cancelled.

Specified by:

scheduleWithDynamicInterval in interface TimeScheduler

Parameters:

task - the task to execute

setThreadFactory

public void setThreadFactory(ThreadFactory factory)

Specified by:

setThreadFactory in interface TimeScheduler

dumpTimerTasks

public java.lang.String dumpTimerTasks()

Description copied from interface: TimeScheduler

Returns a list of tasks currently waiting for execution. If there are a lot of tasks, the returned string should probably only return the number of tasks rather than a full dump.

Specified by:

dumpTimerTasks in interface TimeScheduler

Returns:

getMinThreads

public int getMinThreads()

Description copied from interface: TimeScheduler

Returns the configured core threads, or -1 if not applicable

Specified by:

getMinThreads in interface TimeScheduler

Returns:

setMinThreads

public void setMinThreads(int size)

Description copied from interface: TimeScheduler

Sets the core pool size. Can be ignored if not applicable

Specified by:

setMinThreads in interface TimeScheduler

getMaxThreads

public int getMaxThreads()

Description copied from interface: TimeScheduler

Returns the configured max threads, or -1 if not applicable

Specified by:

getMaxThreads in interface TimeScheduler

Returns:

setMaxThreads

public void setMaxThreads(int size)

Description copied from interface: TimeScheduler

Sets the max pool size. Can be ignored if not applicable

Specified by:

setMaxThreads in interface TimeScheduler

getKeepAliveTime

public long getKeepAliveTime()

Description copied from interface: TimeScheduler

Returns the keep alive time (in ms) of the thread pool, or -1 if not applicable

Specified by:

getKeepAliveTime in interface TimeScheduler

setKeepAliveTime

public void setKeepAliveTime(long time)

Description copied from interface: TimeScheduler

Sets the keep alive time (in ms) of the thread pool. Can be ignored if not applicable

Specified by:

setKeepAliveTime in interface TimeScheduler

getCurrentThreads

public int getCurrentThreads()

Description copied from interface: TimeScheduler

Returns the current threads in the pool, or -1 if not applicable

Specified by:

getCurrentThreads in interface TimeScheduler

Returns:

size

public int size()

Description copied from interface: TimeScheduler

Returns the number of tasks currently in the queue.

Specified by:

size in interface TimeScheduler

Returns:

The number of tasks currently in the queue.

stop

public void stop()

Description copied from interface: TimeScheduler

Stops the scheduler if running, cancelling all pending tasks

Specified by:

stop in interface TimeScheduler

isShutdown

public boolean isShutdown()

Description copied from interface: TimeScheduler

Returns true if stop() has been called, false otherwise

Specified by:

isShutdown in interface TimeScheduler