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

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

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

A type of Message that pertains to the modification and management of Packs in the PackManager.

Author:
Brian Ellis


Public Types

enum  PackMessageType
 The possible types of a PackMessage. More...

Public Member Functions

 PackMessage (PackManager manager, PackMessageType type, Pack pack)
 Constructs a RelevantActionMessage for the given manager, message type, and action list.
 PackMessage (PackManager manager, PackMessageType type, Pack pack, Map< String, Object > userInfo)
 Constructs a RelevantActionMessage for the given manager, message type, resource list, and user info map.
Pack getPack ()
 Accessor method for pack.

Static Public Attributes

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

static final String OLD_RESOURCES = "OldResources"
static final String NEW_RESOURCES = "NewResources"

Private Member Functions

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

Private Attributes

Pack pack
 The pack to which this message pertains.

Static Private Attributes

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


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::PackMessage::PackMessageType

The possible types of a PackMessage.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.PackMessage.PackMessage ( PackManager  manager,
PackMessageType  type,
Pack  pack 
)

Constructs a RelevantActionMessage for the given manager, message type, and action list.

Parameters:
manager the manager sending the message
type the type of the message
pack the pack to which the message pertains

edu.cmu.hcii.calo.messagePassing.PackMessage.PackMessage ( PackManager  manager,
PackMessageType  type,
Pack  pack,
Map< String, Object >  userInfo 
)

Constructs a RelevantActionMessage for the given manager, message type, resource list, and user info map.

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

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

Private constructor.

Use RelevantActionMessage.RelevantActionMessage(Observable, MessageType, List) instead.

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

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

Private constructor.

Use RelevantActionMessage.RelevantActionMessage(Observable, MessageType, List, 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

Pack edu.cmu.hcii.calo.messagePassing.PackMessage.getPack (  ) 

Accessor method for pack.

Returns:
the value of pack


Member Data Documentation

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

To prevent serialization collisions.

Pack edu.cmu.hcii.calo.messagePassing.PackMessage.pack [private]

The pack 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