cern.laser.console

Class CommentedAlarmMap

java.lang.Object

cern.laser.console.CommentedAlarmMap

All Implemented Interfaces:

java.io.Serializable

public class CommentedAlarmMap
extends java.lang.Object
implements java.io.Serializable

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

Author:

F.Calderini

See Also:

CommentedAlarm, Comment, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommentedAlarmMap() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this hashtable so that it contains no alarms.
boolean	containsKey(java.lang.String alarmId) Tests if the specified alarm is a key in this hashtable.
CommentedAlarm	get(java.lang.String alarmId) Returns the commented alarm to which the specified alarm identifier is mapped in this hashtable.
boolean	isEmpty() Tests if this hashtable maps no alarms to comments.
CommentedAlarm	put(CommentedAlarm alarm) Maps the specified commented alarm in this hashtable.
void	putAll(CommentedAlarmMap alarms) Copies all the mappings from the specified CommentedAlarmMap to this one.
CommentedAlarm	remove(java.lang.String alarmId) Removes the commented alarm to which the specified alarm identifeir is mapped in this hashtable.
int	size() Returns the number of commented alarms in this hashtable.
java.lang.String	toString() Returns a string representation.
java.util.Collection	values() Returns a collection of the commented alarms in this hashtable.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentedAlarmMap

public CommentedAlarmMap()

Constructor.

Method Detail

put

public CommentedAlarm 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.

putAll

public void putAll(CommentedAlarmMap alarms)

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

Parameters:

alarms - the commented alarm map.

get

public CommentedAlarm get(java.lang.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.

remove

public CommentedAlarm remove(java.lang.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.

containsKey

public boolean containsKey(java.lang.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

clear

public void clear()

Clears this hashtable so that it contains no alarms.

isEmpty

public boolean isEmpty()

Tests if this hashtable maps no alarms to comments.

Returns:

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

values

public java.util.Collection values()

Returns a collection of the commented alarms in this hashtable.

Returns:

a collection of the commented alarms in this hashtable.

size

public int size()

Returns the number of commented alarms in this hashtable.

Returns:

the number of commented alarms in this hashtable.

toString

public java.lang.String toString()

Returns a string representation.

Overrides:

toString in class java.lang.Object

Returns:

a string representation.