cern.laser.console.CommentedAlarmMap Class Reference

Inherits java::io::Serializable.

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 ()

---

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

(

)

Constructor.

---

Member Function Documentation

void cern.laser.console.CommentedAlarmMap.clear

(

)

Clears this hashtable so that it contains no alarms.

boolean cern.laser.console.CommentedAlarmMap.containsKey

(

String

alarmId

)

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

)

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

(

)

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

)

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.

References cern.laser.console.CommentedAlarm.getAlarm().

void cern.laser.console.CommentedAlarmMap.putAll

(

CommentedAlarmMap

alarms

)

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

Parameters:

alarms

the commented alarm map.

References cern.laser.console.CommentedAlarm.getAlarm(), and cern.laser.console.CommentedAlarmMap.values().

CommentedAlarm cern.laser.console.CommentedAlarmMap.remove

(

String

alarmId

)

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

(

)

Returns the number of commented alarms in this hashtable.

Returns:

the number of commented alarms in this hashtable.

String cern.laser.console.CommentedAlarmMap.toString

(

)

Returns a string representation.

Returns:

a string representation.

References cern.laser.console.CommentedAlarmMap.values().

Collection cern.laser.console.CommentedAlarmMap.values

(

)

Returns a collection of the commented alarms in this hashtable.

Returns:

a collection of the commented alarms in this hashtable.

Referenced by cern.laser.console.CommentedAlarmMap.putAll(), and cern.laser.console.CommentedAlarmMap.toString().

---

The documentation for this class was generated from the following file:

• CommentedAlarmMap.java