org.ginsim.core.notification

Class Notification

java.lang.Object

org.ginsim.core.notification.Notification

All Implemented Interfaces:

Comparable, TimeoutObject

Direct Known Subclasses:

ErrorNotification, InformationNotification, WarningNotification

public abstract class Notification
extends Object
implements TimeoutObject, Comparable

A notification message

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	topic

Constructor Summary

Constructors

Constructor and Description
Notification(Object topic, String message, NotificationType type)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object obj) Compare the notification to the given object.
String	getMessage() Get the message describing this notification.
Object	getTopic() Return the topic the notification is related to
NotificationType	getType()
void	timeout() the timeout is elapsed
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

topic

protected Object topic

Constructor Detail

Notification

public Notification(Object topic,
                    String message,
                    NotificationType type)

Parameters:

graph - the Graph the notification is associated to

message - the message of the notification

type - the type of the notification. See constants on Notification class.

Method Detail

getTopic

public Object getTopic()

Return the topic the notification is related to

Returns:

the topic the notification is related to

getMessage

public String getMessage()

Get the message describing this notification.

Returns:

the message describing this notification

timeout

public void timeout()

Description copied from interface: TimeoutObject

the timeout is elapsed

Specified by:

timeout in interface TimeoutObject

toString

public String toString()

Overrides:

toString in class Object

getType

public NotificationType getType()

Returns:

the type of this notification.

compareTo

public int compareTo(Object obj)

Compare the notification to the given object. If this object is a Notification, the comparison is made on the type

Specified by:

compareTo in interface Comparable

Parameters:

obj - the object to compare

Returns:

a negative value if the given notification is less important a positive value if the given notification is more important a zero if the two notification have the same importance or the given object is not a Notification