de.cismet.commons.utils

Class ProgressEvent

java.lang.Object

java.util.EventObject

de.cismet.commons.utils.ProgressEvent

All Implemented Interfaces:

Serializable

public final class ProgressEvent
extends EventObject

Simple class to indicate that some event occurred at a currently progressing operation.

Version:

1.0

Author:

martin.scholl@cismet.de

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressEvent.State The possible states of a progress event.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(Object source, ProgressEvent.State state) Creates a new ProgressEvent object.
ProgressEvent(Object source, ProgressEvent.State state, int step, int maxSteps) Creates a new ProgressEvent object.
ProgressEvent(Object source, ProgressEvent.State state, int step, int maxSteps, String message) Creates a new ProgressEvent object.
ProgressEvent(Object source, ProgressEvent.State state, String message) Creates a new ProgressEvent object.

Method Summary

Modifier and Type	Method and Description
int	getMaxSteps() The maximal amount of steps of the observed progressing process.
String	getMessage() Gets the message associated with this event.
int	getPercentFinished() Gets the finish percentage.
ProgressEvent.State	getState() Gets the State of this ProgressEvent.
int	getStep() The current step of the observed progressing process.
boolean	isIndeterminate() Returns the isIndeterminate state of the ProgressEvent.
String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressEvent

public ProgressEvent(Object source,
                     ProgressEvent.State state)

Creates a new ProgressEvent object. Equal to calling ProgressEvent(java.lang.Object, de.cismet.commons.utils.ProgressEvent.State, int, int) with 0 as step and 0 as maxSteps.

Parameters:

source - the source of the event

state - the state of the event

ProgressEvent

public ProgressEvent(Object source,
                     ProgressEvent.State state,
                     String message)

Creates a new ProgressEvent object. Equal to calling ProgressEvent(java.lang.Object, de.cismet.commons.utils.ProgressEvent.State, int, int, java.lang.String) with 0 as step and 0 as maxSteps.

Parameters:

source - the source of the event

state - the state of the event

message - the message to indicate what this event is all about, usually localised

ProgressEvent

public ProgressEvent(Object source,
                     ProgressEvent.State state,
                     int step,
                     int maxSteps)

Creates a new ProgressEvent object. Equal to calling ProgressEvent(java.lang.Object, de.cismet.commons.utils.ProgressEvent.State, int, int, java.lang.String) with null as message.

Parameters:

source - the source of the event

state - the state of the event

step - the current step or 0 if it is isIndeterminate

maxSteps - the current maxsteps of 0 if it is isIndeterminate

ProgressEvent

public ProgressEvent(Object source,
                     ProgressEvent.State state,
                     int step,
                     int maxSteps,
                     String message)

Creates a new ProgressEvent object.

Parameters:

source - the source of the event

state - the state of the event

step - the current step or 0 if it is isIndeterminate

maxSteps - the current maxsteps of 0 if it is isIndeterminate

message - the message to indicate what this event is all about, usually localised

Method Detail

getState

public ProgressEvent.State getState()

Gets the State of this ProgressEvent.

Returns:

the State of this ProgressEvent

getPercentFinished

public int getPercentFinished()

Gets the finish percentage.

Returns:

0 <= percent <= 100 or -1 if the event isIndeterminate()

isIndeterminate

public boolean isIndeterminate()

Returns the isIndeterminate state of the ProgressEvent. A ProgressEvent is considered isIndeterminate if either getStep() or getMaxSteps() is 0.

Returns:

true if either getStep() or getMaxSteps() is 0

getStep

public int getStep()

The current step of the observed progressing process.

Returns:

the current step or 0if current step is unknown and thus the progress isIndeterminate().

getMaxSteps

public int getMaxSteps()

The maximal amount of steps of the observed progressing process.

Returns:

the maximal amount of steps or 0 if it is unknown and thus the progress isIndeterminate().

getMessage

public String getMessage()

Gets the message associated with this event.

Returns:

the message associated with this event

toString

public String toString()

Overrides:

toString in class EventObject