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

Class IntersectedAlarmDefinition

java.lang.Object

com.inductiveautomation.ignition.common.alarming.config.IntersectedAlarmDefinition

All Implemented Interfaces:

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

public class IntersectedAlarmDefinition
extends java.lang.Object
implements AlarmDefinition

See Also:

Serialized Form

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
IntersectedAlarmDefinition(java.util.List<AlarmDefinition> alarms)

Method Summary

Modifier and Type	Method	Description
boolean	contains(Property<?> prop)
<T> T	get(Property<T> prop)	Retrieves the value of the property, or null if this set doesn't contain that property.
BoundAlarmProperty	getBoundProperty(Property<?> property)
int	getCount()
java.lang.String	getName()
<T> T	getOrDefault(Property<T> prop)
<T> T	getOrElse(Property<T> property, T value)	Get the value for a given Property, or else fall back to value if it's not present.
java.util.Collection<Property<?>>	getProperties()
java.util.List<PropertyValue>	getValues()	Returns the opaque PropertyValue objects.
boolean	isExtended(Property<?> prop)	Returns whether this property set contains a value for the prop, and the prop was actually inherited.
boolean	isInherited(Property<?> prop)	Indicates whether the property was inherited from a parent type.
boolean	isPropertyBound(Property<?> prop)
java.util.Iterator<PropertyValue>	iterator()
void	merge(PropertySet other)
void	remove(Property<?> prop)
<T> void	set(Property<T> prop, T value)
void	set(PropertyValue propValue)
void	setBoundProperty(Property<?> property, BoundAlarmProperty value)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

merge

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

extend, getExtension, newDefaultInstance, newExtension

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

getNonNull, getNonNull

Constructor Detail

IntersectedAlarmDefinition

public IntersectedAlarmDefinition(java.util.List<AlarmDefinition> alarms)

Method Detail

set

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

Specified by:

set in interface MutablePropertyValueSource

set

public void set(PropertyValue propValue)

Specified by:

set in interface MutablePropertyValueSource

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

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

get

public <T> T get(Property<T> prop)

Description copied from interface: PropertyValueSource

Retrieves the value of the property, or null if this set doesn't contain that property.

Specified by:

get in interface PropertyValueSource

remove

public void remove(Property<?> prop)

Specified by:

remove in interface MutablePropertyValueSource

getOrDefault

public <T> T getOrDefault(Property<T> prop)

Specified by:

getOrDefault in interface PropertyValueSource

Returns:

The value for prop or Property.getDefaultValue() if not present. Can return null if the value is null.

getOrElse

public <T> T getOrElse(Property<T> property,
                       T value)

Description copied from interface: PropertyValueSource

Get the value for a given Property, or else fall back to value if it's not present.

Specified by:

getOrElse in interface PropertyValueSource

Parameters:

property - The Property for which a value is to be retrieved.

value - The value to default to if property isn't present.

Returns:

The value of property if present, value if not. Can return null if the value is null.

getProperties

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

Specified by:

getProperties in interface PropertyValueSource

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

contains

public boolean contains(Property<?> prop)

Specified by:

contains in interface PropertyValueSource

Returns:

True if the source contains a value for prop.

getCount

public int getCount()

Specified by:

getCount in interface Countable

iterator

public java.util.Iterator<PropertyValue> iterator()

Specified by:

iterator in interface java.lang.Iterable<PropertyValue>

isExtended

public boolean isExtended(Property<?> prop)

Description copied from interface: PropertySet

Returns whether this property set contains a value for the prop, and the prop was actually inherited. In other words, this is true if the property is inherited, and an override value is present.

Specified by:

isExtended in interface PropertySet

isInherited

public boolean isInherited(Property<?> prop)

Description copied from interface: PropertySet

Indicates whether the property was inherited from a parent type.

Specified by:

isInherited in interface PropertySet

merge

public void merge(PropertySet other)

Specified by:

merge in interface Mergable<PropertySet>