org.vizzini.util.event
Class StatusEvent

java.lang.Object
  org.vizzini.util.event.StatusEvent

All Implemented Interfaces:

IEvent

public class StatusEvent
extends Object
implements IEvent

Provides an event for status changes. This class is immutable so that listeners can't inadvertantly alter instances.

Since:

v0.1

Version:

v0.2

Author:

Jeffrey M. Thompson

Field Summary

static int	DEFAULT_DISPLAY_TIME Default display time.
static int	FOREVER_DISPLAY_TIME Forever display time.

Constructor Summary

StatusEvent(int position, String message)
Construct this object with the given parameter.

StatusEvent(int position, String message, int displayTime)
Construct this object with the given parameter.

StatusEvent(String message)
Construct this object with the given parameter.

StatusEvent(String message, int displayTime)
Construct this object with the given parameter.

Method Summary

int	getDisplayTime() Return the display time.
String	getMessage() Return the message.
int	getPosition() Return the position.

Methods inherited from class java.lang.Object

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

Field Detail

FOREVER_DISPLAY_TIME

public static final int FOREVER_DISPLAY_TIME

Forever display time.

See Also:

Constant Field Values

DEFAULT_DISPLAY_TIME

public static final int DEFAULT_DISPLAY_TIME

Default display time.

See Also:

Constant Field Values

Constructor Detail

StatusEvent

public StatusEvent(String message)

Construct this object with the given parameter.

Parameters:

message - Status message.

Since:

v0.1

StatusEvent

public StatusEvent(String message,
                   int displayTime)

Construct this object with the given parameter.

Parameters:

message - Status message.

displayTime - Time for which to display the message.

Since:

v0.1

StatusEvent

public StatusEvent(int position,
                   String message)

Construct this object with the given parameter.

Parameters:

position - Status position.

message - Status message.

Since:

v0.1

StatusEvent

public StatusEvent(int position,
                   String message,
                   int displayTime)

Construct this object with the given parameter.

Parameters:

position - Status position.

message - Status message.

displayTime - Time for which to display the message.

Since:

v0.1

Method Detail

getDisplayTime

public int getDisplayTime()

Return the display time.

Since:

v0.1

getMessage

public String getMessage()

Return the message.

Since:

v0.1

getPosition

public int getPosition()

Return the position.

Since:

v0.1