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

Class BasicAlarmDefinition

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

com.inductiveautomation.ignition.common.alarming.config.BasicAlarmDefinition

All Implemented Interfaces:

AlarmDefinition, Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, java.io.Serializable, java.lang.Iterable<PropertyValue>

public class BasicAlarmDefinition
extends BasicPropertySet
implements AlarmDefinition

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

BasicPropertySet.Builder

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet

EMPTY

Constructor Summary

Constructors

Constructor	Description
BasicAlarmDefinition()
BasicAlarmDefinition(AlarmDefinition copy)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.Map<Property<?>,BoundAlarmProperty>	getBoundProperties()
BoundAlarmProperty	getBoundProperty(Property<?> property)
java.lang.String	getName()
java.util.Collection<Property<?>>	getProperties()
java.util.List<PropertyValue>	getValues()	Returns the opaque PropertyValue objects.
boolean	isPropertyBound(Property<?> prop)
void	merge(PropertySet other, boolean localOnly)	Merges the values from other collection into this one.
void	remove(Property<?> prop)
<T> void	set(Property<T> prop, T value)
void	set(PropertyValue propValue)
void	setBoundProperties(java.util.Map<Property<?>,BoundAlarmProperty> boundProperties)
void	setBoundProperty(Property<?> property, BoundAlarmProperty value)
void	setName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicPropertySet

addPropertyChangeListener, addPropertyChangeListener, change, coerceValue, contains, firePropertyChange, get, getCount, getExtension, getOrDefault, getOrElse, getRaw, getRawValueMap, isExtended, isInherited, iterator, of, removePropertyChangeListener, removePropertyChangeListener, setDirect, setImpl, setRawValueMap

Methods inherited from class java.lang.Object

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

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

getCount

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

merge

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

extend, getExtension, isExtended, isInherited, newDefaultInstance, newExtension

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

contains, get, getNonNull, getNonNull, getOrDefault, getOrElse

Constructor Detail

BasicAlarmDefinition

public BasicAlarmDefinition()

BasicAlarmDefinition

public BasicAlarmDefinition(AlarmDefinition copy)

Method Detail

getBoundProperties

public java.util.Map<Property<?>,BoundAlarmProperty> getBoundProperties()

setBoundProperties

public void setBoundProperties(java.util.Map<Property<?>,BoundAlarmProperty> boundProperties)

getName

public java.lang.String getName()

Specified by:

getName in interface AlarmDefinition

setName

public void setName(java.lang.String name)

Specified by:

setName in interface AlarmDefinition

isPropertyBound

public boolean isPropertyBound(Property<?> prop)

Specified by:

isPropertyBound in interface AlarmDefinition

set

public <T> void set(Property<T> prop,
                    T value)

Specified by:

set in interface MutablePropertyValueSource

Overrides:

set in class BasicPropertySet

set

public void set(PropertyValue propValue)

Specified by:

set in interface MutablePropertyValueSource

Overrides:

set in class BasicPropertySet

setBoundProperty

public void setBoundProperty(Property<?> property,
                             BoundAlarmProperty value)

Specified by:

setBoundProperty in interface AlarmDefinition

getBoundProperty

public BoundAlarmProperty getBoundProperty(Property<?> property)

Specified by:

getBoundProperty in interface AlarmDefinition

remove

public void remove(Property<?> prop)

Specified by:

remove in interface MutablePropertyValueSource

Overrides:

remove in class BasicPropertySet

getProperties

public java.util.Collection<Property<?>> getProperties()

Specified by:

getProperties in interface PropertyValueSource

Overrides:

getProperties in class BasicPropertySet

getValues

public java.util.List<PropertyValue> getValues()

Description copied from interface: PropertyValueSource

Returns the opaque PropertyValue objects. This can be useful when you want to avoid the strict type checking of the value, and it's important to note that if the property is bound, the value will be a BoundValue. Be very careful about overriding, and make sure to maintain the methodology of using getProperties to iterate and get (or getOrDefault), to get the value, because those are all handled differently by BoundPropertySets, ExtendedPropertySets, etc.

Specified by:

getValues in interface PropertyValueSource

Overrides:

getValues in class BasicPropertySet

toString

public java.lang.String toString()

Overrides:

toString in class BasicPropertySet

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class BasicPropertySet

merge

public void merge(PropertySet other,
                  boolean localOnly)

Description copied from interface: Mergable

Merges the values from other collection into this one. Replaces any currently existing value with those from the other set.

Specified by:

merge in interface Mergable<PropertySet>

Specified by:

merge in interface MutablePropertyValueSource