com.goldencode.p2j.util

Class StopAfterTimer

java.lang.Object

com.goldencode.p2j.util.StopAfterTimer

public class StopAfterTimer
extends java.lang.Object

Provides runtime support for stop-after statement for blocks doBlock, forBlock, repeatBlock.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	StopAfterTimer.Task Task class responsible for interruption of the Progress block.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	contextName Name of the thread for which the timer is set
private Control	control Session for the current execution context
private java.util.concurrent.locks.ReentrantLock	lock Lock used for locking cleanup methods
private static CentralLogger	LOG Logger
private StopAfterTimer.Task	previousTaskBlock Previous task created for the last block
private java.util.concurrent.Semaphore	semaphore Semaphore used for avoid race condition between two consecutive interrupts
private boolean	stopConditionRaised StopCondition was raised by a stop-after timeout
private BlockDefinition	stopedBlock Blocked stopped by stop-after statement
private java.util.Map<BlockDefinition,StopAfterTimer.Task>	tasks Stores the interruption task for each block.
private java.util.Timer	timer Timer responsible of execution a interruption tasks.

Constructor Summary

Constructors

Constructor and Description
StopAfterTimer(java.lang.String contextName, Control threadControl) Creates a managing StopAfterTimer object for a given session.

Method Summary

Modifier and Type	Method and Description
StopAfterTimer.Task	addTimeOut(BlockDefinition blockDefinition, long timeout) Adds a new timer task to the timer queue.
void	cleanUp() Release of the acquired semaphore and resets stopConditionRaised.
boolean	isBlockRegistered(BlockDefinition blockDefinition) Checks if the block that was given as an parameter is already present in the timer task
boolean	isStopAfterConditionRaised() Checks if the a StopCondition was raised by stop-after timeout.
boolean	isStoppedBlock(BlockDefinition blockDefinition) Checks if the block that was given as an parameter was stopped by a StopCondition raised by a stop-after timeout.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

tasks

private java.util.Map<BlockDefinition,StopAfterTimer.Task> tasks

Stores the interruption task for each block.

control

private Control control

Session for the current execution context

timer

private java.util.Timer timer

Timer responsible of execution a interruption tasks.

previousTaskBlock

private StopAfterTimer.Task previousTaskBlock

Previous task created for the last block

stopedBlock

private BlockDefinition stopedBlock

Blocked stopped by stop-after statement

stopConditionRaised

private boolean stopConditionRaised

StopCondition was raised by a stop-after timeout

contextName

private java.lang.String contextName

Name of the thread for which the timer is set

semaphore

private java.util.concurrent.Semaphore semaphore

Semaphore used for avoid race condition between two consecutive interrupts

lock

private final java.util.concurrent.locks.ReentrantLock lock

Lock used for locking cleanup methods

Constructor Detail

StopAfterTimer

public StopAfterTimer(java.lang.String contextName,
                      Control threadControl)

Creates a managing StopAfterTimer object for a given session.

Parameters:

session - The session of the current execution context.

Method Detail

isStoppedBlock

public boolean isStoppedBlock(BlockDefinition blockDefinition)

Checks if the block that was given as an parameter was stopped by a StopCondition raised by a stop-after timeout.

Parameters:

blockDefinition - Progress block for which we check stop-after timeout.

Returns:

true, if blockDefinition was stopped by an stop-after timeout, or false otherwise.

isStopAfterConditionRaised

public boolean isStopAfterConditionRaised()

Checks if the a StopCondition was raised by stop-after timeout.

isBlockRegistered

public boolean isBlockRegistered(BlockDefinition blockDefinition)

Checks if the block that was given as an parameter is already present in the timer task

Parameters:

blockDefinition - Progress block.

Returns:

true, if blockDefinition is already present in timer task queue, or false otherwise.

cleanUp

public void cleanUp()

Release of the acquired semaphore and resets stopConditionRaised.

addTimeOut

public StopAfterTimer.Task addTimeOut(BlockDefinition blockDefinition,
                                      long timeout)

Adds a new timer task to the timer queue.

Parameters:

blockDefinition - Block for which the timeout wants to be set.

timeout - Number of seconds to be set as a timeout for blockDefinition.

Throws:

TimeOutException - if timeout is equals to zero.