com.softwareag.mobile.runtime.toolkit.operations.queue

Class BasicOperationQueue

java.lang.Object

com.softwareag.mobile.runtime.toolkit.operations.queue.BasicOperationQueue

All Implemented Interfaces:

IOperationQueue

Direct Known Subclasses:

ConditionalOperationQueue

public class BasicOperationQueue
extends java.lang.Object
implements IOperationQueue

This IOperationQueue offers a basic way to execute a bunch of IOperations. The queue can be configured to execute the operations serial (with one thread) or in parallel (multithreaded) by using BasicOperationQueue(int)
The IOperations are executed right after adding them with addOperation(IOperation) or addOperations(Vector). The execution can be suspended and resumed with suspend() and resume().

Version:

10.1.0.0000-0462

Constructor Summary

Constructors

Constructor and Description
BasicOperationQueue() Create a new queue.
BasicOperationQueue(boolean startRunner) Create a new queue in suspended state.
BasicOperationQueue(int maxParallelOperations) Create a new queue with maximum of parallel executions defined by the given parameter.
BasicOperationQueue(int maxParallelOperations, boolean startRunner) Create a new queue with maximum of parallel executions defined by the given parameter.

Method Summary

Modifier and Type	Method and Description
void	addDelegate(IOperationDelegate delegate) add a IOperationDelegate that will be notified of events happening with each IOperations in the queue.
void	addDelegate(IOperationQueueDelegate queueDelegate) add a IOperationQueueDelegate that will be notified of events happening with the queue, e.g.
void	addOperation(IOperation o) add the given IOperation to the queue
void	addOperations(java.util.Vector newOperations) add a bunch of IOperations to the queue
int	getSize()
boolean	isIdle()
void	removeDelegate(IOperationDelegate delegate) remove a IOperationDelegate
void	removeDelegate(IOperationQueueDelegate queueDelegate) remove a IOperationQueueDelegate
void	reset() reset the queue as if it were new, i.e.
void	resume() resume the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in running
void	suspend() halt the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in suspended mode

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicOperationQueue

public BasicOperationQueue()

Create a new queue. The maximum number of parallel executions is determined by the number of cores in the device. The queue is immediately started.

BasicOperationQueue

public BasicOperationQueue(int maxParallelOperations)

Create a new queue with maximum of parallel executions defined by the given parameter.

Parameters:

maxParallelOperations - the number of parallel executions

BasicOperationQueue

public BasicOperationQueue(boolean startRunner)

Create a new queue in suspended state. Use resume() to start the execution.

Parameters:

startRunner - if true, the queue will start immediately, otherwise it will be suspended until explicitly resumed with resume()

BasicOperationQueue

public BasicOperationQueue(int maxParallelOperations,
                           boolean startRunner)

Create a new queue with maximum of parallel executions defined by the given parameter. The second parameter determines if the queue should be started immediately.

Parameters:

maxParallelOperations - the number of parallel executions; must be a positive number

startRunner - if true, the queue will start immediately, otherwise it will be suspended until explicitly resumed with resume()

Method Detail

reset

public void reset()

Description copied from interface: IOperationQueue

reset the queue as if it were new, i.e. remove all operations

Specified by:

reset in interface IOperationQueue

suspend

public void suspend()

Description copied from interface: IOperationQueue

halt the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in suspended mode

Specified by:

suspend in interface IOperationQueue

resume

public void resume()

Description copied from interface: IOperationQueue

resume the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in running

Specified by:

resume in interface IOperationQueue

isIdle

public boolean isIdle()

Specified by:

isIdle in interface IOperationQueue

Returns:

true if there are no operations in the queue and no operations are currently executed; false otherwise

addOperation

public void addOperation(IOperation o)

Description copied from interface: IOperationQueue

add the given IOperation to the queue

Specified by:

addOperation in interface IOperationQueue

Parameters:

o - the IOperation to be added

addOperations

public void addOperations(java.util.Vector newOperations)

Description copied from interface: IOperationQueue

add a bunch of IOperations to the queue

Specified by:

addOperations in interface IOperationQueue

Parameters:

newOperations - the IOperations to be added

getSize

public int getSize()

Specified by:

getSize in interface IOperationQueue

Returns:

the number of operations currently in the queue

addDelegate

public void addDelegate(IOperationDelegate delegate)

Description copied from interface: IOperationQueue

add a IOperationDelegate that will be notified of events happening with each IOperations in the queue. If the same IOperationDelegate is already added, it will not be added again.

Specified by:

addDelegate in interface IOperationQueue

Parameters:

delegate - the IOperationDelegate to be added

removeDelegate

public void removeDelegate(IOperationDelegate delegate)

Description copied from interface: IOperationQueue

remove a IOperationDelegate

Specified by:

removeDelegate in interface IOperationQueue

Parameters:

delegate - the IOperationDelegate to be removed

addDelegate

public void addDelegate(IOperationQueueDelegate queueDelegate)

Description copied from interface: IOperationQueue

add a IOperationQueueDelegate that will be notified of events happening with the queue, e.g. when the queue is finished. If the same IOperationQueueDelegate is already added, it will not be added again.

Specified by:

addDelegate in interface IOperationQueue

removeDelegate

public void removeDelegate(IOperationQueueDelegate queueDelegate)

Description copied from interface: IOperationQueue

remove a IOperationQueueDelegate

Specified by:

removeDelegate in interface IOperationQueue

Parameters:

queueDelegate - the IOperationQueueDelegate to be removed