info.pppc.base.system.operation

Class NullMonitor

java.lang.Object

info.pppc.base.system.operation.NullMonitor

All Implemented Interfaces:

IMonitor

public class NullMonitor
extends java.lang.Object
implements IMonitor

The null monitor implements a simple monitor that can be canceled.

Author:

Marcus Handte

Field Summary

Fields inherited from interface info.pppc.base.system.operation.IMonitor

EVENT_MONITOR_CANCEL, EVENT_MONITOR_DONE, EVENT_MONITOR_NAME, EVENT_MONITOR_START, EVENT_MONITOR_STEP, STEP_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
NullMonitor() Creates a new null monitor that can be used to observe a task.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMonitorListener(int types, IListener listener) Adds the specified listener for the specified set of events.
void	cancel() Called to signal that the operation has been canceled.
void	done() Called to signal that the operation has been finished.
java.lang.String	getName() Returns the name of the current operation.
int	getStep() Returns the current step of the operation.
int	getTotal() Returns the total number of steps performed by the current operation.
boolean	isCanceled() Determines whether the task should be canceled.
boolean	isDone() Determines whether the operation is still running.
void	join() Waits until the operation that is connected to the monitor has been completed.
boolean	removeMonitorListener(int types, IListener listener) Removes a previously registered listener from the set of registered listeners.
void	setName(java.lang.String operation) Sets the name of the operation that is currently executed.
void	start(int total) Starts the operation and sets the total number of steps performed by the operation.
void	step(int steps) Informs the monitor that the specified number of steps have been performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullMonitor

public NullMonitor()

Creates a new null monitor that can be used to observe a task.

Method Detail

addMonitorListener

public void addMonitorListener(int types,
                      IListener listener)

Adds the specified listener for the specified set of events.

Specified by:

addMonitorListener in interface IMonitor

Parameters:

types - The types of events to register.

listener - The listener to register.

removeMonitorListener

public boolean removeMonitorListener(int types,
                            IListener listener)

Removes a previously registered listener from the set of registered listeners.

Specified by:

removeMonitorListener in interface IMonitor

Parameters:

types - The types of events to unregister.

listener - The listener to unregister.

Returns:

True if the listener has been unregistered.

getName

public java.lang.String getName()

Returns the name of the current operation.

Returns:

The name of the current operation.

setName

public void setName(java.lang.String operation)

Sets the name of the operation that is currently executed.

Specified by:

setName in interface IMonitor

Parameters:

operation - The name of the operation that is currently executed.

start

public void start(int total)

Starts the operation and sets the total number of steps performed by the operation.

Specified by:

start in interface IMonitor

Parameters:

total - The total number of steps performed by the operation.

getTotal

public int getTotal()

Returns the total number of steps performed by the current operation.

Returns:

The total number of steps.

step

public void step(int steps)

Informs the monitor that the specified number of steps have been performed.

Specified by:

step in interface IMonitor

Parameters:

steps - The number of steps that have been performed.

getStep

public int getStep()

Returns the current step of the operation.

Returns:

The current step of the operation.

done

public void done()

Called to signal that the operation has been finished.

Specified by:

done in interface IMonitor

isDone

public boolean isDone()

Determines whether the operation is still running. Note that while an operation is running, the state of the success flag is not relevant.

Specified by:

isDone in interface IMonitor

Returns:

True if the operation is still running.

cancel

public void cancel()

Called to signal that the operation has been canceled.

Specified by:

cancel in interface IMonitor

isCanceled

public boolean isCanceled()

Determines whether the task should be canceled.

Specified by:

isCanceled in interface IMonitor

Returns:

True if the task should be canceled, false otherwise.

join

public void join()
          throws java.lang.InterruptedException

Waits until the operation that is connected to the monitor has been completed.

Specified by:

join in interface IMonitor

Throws:

java.lang.InterruptedException - If the thread is interrupted while waiting for the join.