Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

cern::laser::console::CommentedAlarmMap Class Reference

List of all members.

Public Member Functions

 CommentedAlarmMap ()
CommentedAlarm put (CommentedAlarm alarm)
void putAll (CommentedAlarmMap alarms)
CommentedAlarm get (String alarmId)
CommentedAlarm remove (String alarmId)
boolean containsKey (String alarmId)
void clear ()
boolean isEmpty ()
Collection values ()
int size ()
String toString ()

Private Attributes

Map adaptee = null

Detailed Description

A generic commented alarm container. It defines a mapping between alarm identifiers and commented alarms.

Author:
F.Calderini
See also:
cern.laser.console.CommentedAlarm

cern.laser.console.Comment


Constructor & Destructor Documentation

cern::laser::console::CommentedAlarmMap::CommentedAlarmMap  )  [inline]
 

Constructor.


Member Function Documentation

void cern::laser::console::CommentedAlarmMap::clear  )  [inline]
 

Clears this hashtable so that it contains no alarms.

boolean cern::laser::console::CommentedAlarmMap::containsKey String  alarmId  )  [inline]
 

Tests if the specified alarm is a key in this hashtable.

Parameters:
alarmId the alarm to check.
Returns:
true if and only if the specified alarm is a key in this hashtable, false otherwise

CommentedAlarm cern::laser::console::CommentedAlarmMap::get String  alarmId  )  [inline]
 

Returns the commented alarm to which the specified alarm identifier is mapped in this hashtable.

Parameters:
alarmId the alarm identifier.
Returns:
the commented alarm to which the alarm identifier is mapped in this hashtable; null if the alarm identifier is not mapped to any commented alarm in this hashtable.

boolean cern::laser::console::CommentedAlarmMap::isEmpty  )  [inline]
 

Tests if this hashtable maps no alarms to comments.

Returns:
true if this hashtable maps no alarms to comments; false otherwise.

CommentedAlarm cern::laser::console::CommentedAlarmMap::put CommentedAlarm  alarm  )  [inline]
 

Maps the specified commented alarm in this hashtable.

Parameters:
alarm the commented alarm.
Returns:
the previous commented alarm in this hashtable, or null if it did not have one.

void cern::laser::console::CommentedAlarmMap::putAll CommentedAlarmMap  alarms  )  [inline]
 

Copies all the mappings from the specified CommentedAlarmMap to this one.

Parameters:
alarms the commented alarm map.

CommentedAlarm cern::laser::console::CommentedAlarmMap::remove String  alarmId  )  [inline]
 

Removes the commented alarm to which the specified alarm identifeir is mapped in this hashtable.

Parameters:
alarmId the alarm to remove.
Returns:
the commented alarm to which the alarm identifier had been mapped in this hashtable; null if the alarm identifier was not mapped to any commented alarm in this hashtable.

int cern::laser::console::CommentedAlarmMap::size  )  [inline]
 

Returns the number of commented alarms in this hashtable.

Returns:
the number of commented alarms in this hashtable.

String cern::laser::console::CommentedAlarmMap::toString  )  [inline]
 

Returns a string representation.

Returns:
a string representation.

Collection cern::laser::console::CommentedAlarmMap::values  )  [inline]
 

Returns a collection of the commented alarms in this hashtable.

Returns:
a collection of the commented alarms in this hashtable.


Member Data Documentation

Map cern::laser::console::CommentedAlarmMap::adaptee = null [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:08:56 2009 for ACS Java API by doxygen 1.3.8