Class AlarmConfigurationDiff
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alarming.config.AlarmConfigurationDiff
-
- All Implemented Interfaces:
AlarmConfiguration
,Countable
,Extendable<AlarmConfiguration>
,Intersectable<AlarmConfiguration>
,Mergable<AlarmConfiguration>
,java.io.Serializable
public class AlarmConfigurationDiff extends java.lang.Object implements AlarmConfiguration
Keeps track of added, modified and removed alarm definitions. Will return a diff for any requested name, so get() should NOT be used to check if the alarm exists. Instead, use contains().- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AlarmConfigurationDiff()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(AlarmDefinition definition)
boolean
contains(java.lang.String name)
protected java.util.Map.Entry<java.lang.String,AlarmDefinition>
find(java.lang.String name)
AlarmDefinition
get(java.lang.String name)
Returns a fresh AlarmDefinitionDiff when first called for a name, unless the name has been removed.int
getCount()
In this case, count does not mean "alarms", but instead, number of edits present.java.util.List<AlarmDefinition>
getDefinitions()
In this case, returns the modified (or new) alarm definitions.java.util.Set<java.lang.String>
getRemoved()
Returns the names of the removed AlarmDefinitions.boolean
hasChanges()
boolean
isInherited(AlarmDefinition definition)
boolean
isModified(java.lang.String name)
boolean
isOverridden(AlarmDefinition definition)
boolean
isRemoved(java.lang.String name)
void
remove(java.lang.String name)
java.lang.String
toString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.common.alarming.config.AlarmConfiguration
extend, getExtension, intersect, merge, newExtension
-
-
-
-
Method Detail
-
getCount
public int getCount()
In this case, count does not mean "alarms", but instead, number of edits present.
-
getRemoved
public java.util.Set<java.lang.String> getRemoved()
Returns the names of the removed AlarmDefinitions.
-
isRemoved
public boolean isRemoved(java.lang.String name)
-
isModified
public boolean isModified(java.lang.String name)
-
getDefinitions
public java.util.List<AlarmDefinition> getDefinitions()
In this case, returns the modified (or new) alarm definitions.- Specified by:
getDefinitions
in interfaceAlarmConfiguration
-
isOverridden
public boolean isOverridden(AlarmDefinition definition)
- Specified by:
isOverridden
in interfaceAlarmConfiguration
-
isInherited
public boolean isInherited(AlarmDefinition definition)
- Specified by:
isInherited
in interfaceAlarmConfiguration
-
remove
public void remove(java.lang.String name)
- Specified by:
remove
in interfaceAlarmConfiguration
-
get
public AlarmDefinition get(java.lang.String name)
Returns a fresh AlarmDefinitionDiff when first called for a name, unless the name has been removed.- Specified by:
get
in interfaceAlarmConfiguration
-
contains
public boolean contains(java.lang.String name)
- Specified by:
contains
in interfaceAlarmConfiguration
-
find
protected java.util.Map.Entry<java.lang.String,AlarmDefinition> find(java.lang.String name)
-
add
public void add(AlarmDefinition definition)
- Specified by:
add
in interfaceAlarmConfiguration
-
hasChanges
public boolean hasChanges()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-