Package com.inductiveautomation.ignition.common.alarming.config

Class BasicAlarmConfiguration

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,AlarmDefinition>

com.inductiveautomation.ignition.common.alarming.config.BasicAlarmConfiguration

All Implemented Interfaces:

AlarmConfiguration, Countable, Extendable<AlarmConfiguration>, Intersectable<AlarmConfiguration>, Mergable<AlarmConfiguration>, Serializable, Cloneable, Map<String,AlarmDefinition>

public class BasicAlarmConfiguration
extends HashMap<String,AlarmDefinition>
implements AlarmConfiguration

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
BasicAlarmConfiguration()
BasicAlarmConfiguration(AlarmConfiguration config)	Copy constructor for AlarmConfiguration, also clones alarm definitions.
BasicAlarmConfiguration(List<AlarmDefinition> definitions)	Creates the alarm configuration with the provided definitions, does not clone them.

Method Summary

Modifier and Type	Method	Description
void	add(AlarmDefinition definition)
void	addAll(List<AlarmDefinition> definitions)
boolean	contains(String name)
boolean	equals(Object o)
AlarmDefinition	get(String name)
int	getCount()
List<AlarmDefinition>	getDefinitions()
boolean	isInherited(AlarmDefinition definition)
boolean	isOverridden(AlarmDefinition definition)
void	remove(String name)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.alarming.config.AlarmConfiguration

extend, getExtension, intersect, merge, newExtension

Methods inherited from interface java.util.Map

hashCode

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Constructor Details

BasicAlarmConfiguration

public BasicAlarmConfiguration()

BasicAlarmConfiguration

public BasicAlarmConfiguration(@Nullable
 AlarmConfiguration config)

Copy constructor for AlarmConfiguration, also clones alarm definitions.

BasicAlarmConfiguration

public BasicAlarmConfiguration(List<AlarmDefinition> definitions)

Creates the alarm configuration with the provided definitions, does not clone them.

Method Details

getCount

public int getCount()

Specified by:

getCount in interface Countable

getDefinitions

public List<AlarmDefinition> getDefinitions()

Specified by:

getDefinitions in interface AlarmConfiguration

get

public AlarmDefinition get(String name)

Specified by:

get in interface AlarmConfiguration

contains

public boolean contains(String name)

Specified by:

contains in interface AlarmConfiguration

isOverridden

public boolean isOverridden(AlarmDefinition definition)

Specified by:

isOverridden in interface AlarmConfiguration

isInherited

public boolean isInherited(AlarmDefinition definition)

Specified by:

isInherited in interface AlarmConfiguration

add

public void add(AlarmDefinition definition)

Specified by:

add in interface AlarmConfiguration

addAll

public void addAll(List<AlarmDefinition> definitions)

remove

public void remove(String name)

Specified by:

remove in interface AlarmConfiguration

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,AlarmDefinition>

Overrides:

equals in class AbstractMap<String,AlarmDefinition>