edu.cmu.hcii.calo.messagePassing.NotificationMessage Class Reference

Inherits edu.cmu.hcii.calo.messagePassing.Message.

Inheritance diagram for edu.cmu.hcii.calo.messagePassing.NotificationMessage:

Inheritance graph
[legend]
Collaboration diagram for edu.cmu.hcii.calo.messagePassing.NotificationMessage:

Collaboration graph
[legend]
List of all members.

Detailed Description

A type of Message that pertains to the modification and management of notification instances.

Author:
Will Haines


Public Types

enum  NotificationMessageType
 The possible types of a NotificationMessage. More...

Public Member Functions

 NotificationMessage (NotificationManager manager, NotificationMessageType type, Notification n)
 Constructs a Notification Message for the given manager, message type, and notification.
 NotificationMessage (NotificationManager manager, NotificationMessageType type, Notification n, Map< String, Object > userInfo)
 Constructs a NotificationMessage for the given manager, message type, notification, and user info map.
Notification getNotification ()
 Accessor method for notification.

Static Public Attributes

User info map keys
These strings are the defined keys for use in the user info dictionary.

static final String OLD_PRIORITY = "OldPriority"
 The old priority.
static final String NEW_PRIORITY = "NewPriority"
 The new priority.
static final String OLD_TEXT = "OldText"
 The old text.
static final String NEW_TEXT = "NewText"
 The new text.
static final String OLD_PERSON = "OldPerson"
 The old person.
static final String NEW_PERSON = "NewPerson"
 The new person.
static final String OLD_NAME = "OldName"
 The old name.
static final String NEW_NAME = "NewName"
 The new name.

Private Member Functions

 NotificationMessage (Observable sender, MessageType type)
 Private constructor.
 NotificationMessage (Observable sender, MessageType type, Map< String, Object > userInfo)
 Private constructor.

Private Attributes

Notification notification
 The notification to which this message pertains.

Static Private Attributes

static final long serialVersionUID = 1708206550814911259L
 To prevent serialization collisions.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::NotificationMessage::NotificationMessageType

The possible types of a NotificationMessage.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.NotificationMessage.NotificationMessage ( NotificationManager  manager,
NotificationMessageType  type,
Notification  n 
)

Constructs a Notification Message for the given manager, message type, and notification.

Parameters:
manager the manager sending the message
type the type of the message
n the notification to which the message pertains

edu.cmu.hcii.calo.messagePassing.NotificationMessage.NotificationMessage ( NotificationManager  manager,
NotificationMessageType  type,
Notification  n,
Map< String, Object >  userInfo 
)

Constructs a NotificationMessage for the given manager, message type, notification, and user info map.

Parameters:
manager the manager sending the message
type the type of the message
n the notification to which the message pertains
userInfo the user info map for this message

edu.cmu.hcii.calo.messagePassing.NotificationMessage.NotificationMessage ( Observable  sender,
MessageType  type 
) [private]

Private constructor.

Use NotificationMessage.NotificationMessage(Observable, MessageType, Notification) instead.

Parameters:
sender the object that sent this message
type the type of this message

edu.cmu.hcii.calo.messagePassing.NotificationMessage.NotificationMessage ( Observable  sender,
MessageType  type,
Map< String, Object >  userInfo 
) [private]

Private constructor.

Use NotificationMessage.NotificationMessage(Observable, MessageType, Notification, Map) instead.

Parameters:
sender the object that sent this message
type the type of this message
userInfo the map of message-specific data associated with this message


Member Function Documentation

Notification edu.cmu.hcii.calo.messagePassing.NotificationMessage.getNotification (  ) 

Accessor method for notification.

Returns:
the value of notification


Member Data Documentation

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.OLD_PRIORITY = "OldPriority" [static]

The old priority.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.NEW_PRIORITY = "NewPriority" [static]

The new priority.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.OLD_TEXT = "OldText" [static]

The old text.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.NEW_TEXT = "NewText" [static]

The new text.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.OLD_PERSON = "OldPerson" [static]

The old person.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.NEW_PERSON = "NewPerson" [static]

The new person.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.OLD_NAME = "OldName" [static]

The old name.

final String edu.cmu.hcii.calo.messagePassing.NotificationMessage.NEW_NAME = "NewName" [static]

The new name.

final long edu.cmu.hcii.calo.messagePassing.NotificationMessage.serialVersionUID = 1708206550814911259L [static, private]

To prevent serialization collisions.

Notification edu.cmu.hcii.calo.messagePassing.NotificationMessage.notification [private]

The notification to which this message pertains.


The documentation for this class was generated from the following file:
Generated on Mon Aug 13 15:06:16 2007 for CALO by  doxygen 1.5.2