Package com.inductiveautomation.ignition.common.config

Class BoundPropertySetDiff

java.lang.Object

com.inductiveautomation.ignition.common.config.PropertySetDiff

com.inductiveautomation.ignition.common.config.BoundPropertySetDiff

All Implemented Interfaces:

BoundPropertySet, Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertySetEdit, PropertyValueSource, Serializable, Iterable<PropertyValue>

public class BoundPropertySetDiff
extends PropertySetDiff
implements BoundPropertySet

See Also:

• Serialized Form

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
BoundPropertySetDiff()
BoundPropertySetDiff(PropertySet copy)

Method Summary

Modifier and Type	Method	Description
boolean	contains(Property<?> prop)
Collection<Property<?>>	getBoundProperties()
BoundValue	getBoundValue(Property<?> prop)
int	getCount()	For the diff, returns the combined size of modified and removed, so it can be used to see if there are any changes, as the value will be >0.
Set<Property<?>>	getModified()
Collection<Property<?>>	getProperties()
List<PropertyValue>	getValues()	Returns the opaque PropertyValue objects.
boolean	hasChanges()
boolean	isBound(Property<?> prop)
boolean	isModified(Property<?> prop)
protected Map<Property<?>,BoundValue>	modifiedBindings()
void	remove(Property<?> prop)
void	revert(Property<?> property)	Removes the property from the modified map, but unlike "remove", doesn't add it to the removed set.
void	setBoundValue(Property<?> prop, BoundValue value)
protected void	setRaw(Property<?> prop, Object value)

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

compactChanges, get, getOrDefault, getOrElse, getRaw, getRemoved, isExtended, isInherited, isRemoved, iterator, set, set, 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.config.BoundPropertySet

extend, getBoundOrDefault, newDefaultInstance, newExtension

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.MutablePropertyValueSource

merge, set, set

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

getExtension, isExtended, isInherited

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

get, getNonNull, getNonNull, getOrDefault, getOrElse

Constructor Details

BoundPropertySetDiff

public BoundPropertySetDiff()

BoundPropertySetDiff

public BoundPropertySetDiff(PropertySet copy)

Method Details

modifiedBindings

protected Map<Property<?>,BoundValue> modifiedBindings()

isBound

public boolean isBound(Property<?> prop)

Specified by:

isBound in interface BoundPropertySet

isModified

public boolean isModified(Property<?> prop)

Specified by:

isModified in interface PropertySetEdit

Overrides:

isModified in class PropertySetDiff

getModified

public Set<Property<?>> getModified()

Overrides:

getModified in class PropertySetDiff

setBoundValue

public void setBoundValue(Property<?> prop,
 BoundValue value)

Specified by:

setBoundValue in interface BoundPropertySet

remove

public void remove(Property<?> prop)

Specified by:

remove in interface MutablePropertyValueSource

Overrides:

remove in class PropertySetDiff

setRaw

protected void setRaw(Property<?> prop,
 Object value)

Overrides:

setRaw in class PropertySetDiff

getBoundValue

public BoundValue getBoundValue(Property<?> prop)

Specified by:

getBoundValue in interface BoundPropertySet

getBoundProperties

public Collection<Property<?>> getBoundProperties()

Specified by:

getBoundProperties in interface BoundPropertySet

revert

public void revert(Property<?> property)

Description copied from class: PropertySetDiff

Removes the property from the modified map, but unlike "remove", doesn't add it to the removed set.

Specified by:

revert in interface PropertySetEdit

Overrides:

revert in class PropertySetDiff

contains

public boolean contains(Property<?> prop)

Specified by:

contains in interface PropertyValueSource

Overrides:

contains in class PropertySetDiff

Returns:

True if the source contains a value for prop.

getCount

public int getCount()

Description copied from class: PropertySetDiff

For the diff, returns the combined size of modified and removed, so it can be used to see if there are any changes, as the value will be >0.

Specified by:

getCount in interface Countable

Overrides:

getCount in class PropertySetDiff

getProperties

public Collection<Property<?>> getProperties()

Specified by:

getProperties in interface PropertyValueSource

Overrides:

getProperties in class PropertySetDiff

hasChanges

public boolean hasChanges()

Overrides:

hasChanges in class PropertySetDiff

getValues

public 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 BoundPropertySet

Specified by:

getValues in interface PropertyValueSource

Overrides:

getValues in class PropertySetDiff