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
,VersionedPropertySet
,java.io.Serializable
,java.lang.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
-
Fields inherited from interface com.inductiveautomation.ignition.common.config.VersionedPropertySet
EMPTY
-
-
Constructor Summary
Constructors Constructor Description BoundPropertySetDiff()
BoundPropertySetDiff(PropertySet copy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(Property<?> prop)
java.util.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.java.util.List<PropertyValue>
getValues()
Returns the opaque PropertyValue objects.boolean
hasChanges()
boolean
isBound(Property<?> prop)
boolean
isModified(Property<?> prop)
protected java.util.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, java.lang.Object value)
-
Methods inherited from class com.inductiveautomation.ignition.common.config.PropertySetDiff
compactChanges, get, getModified, getOrDefault, getOrElse, getProperties, 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 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, getProperties
-
-
-
-
Constructor Detail
-
BoundPropertySetDiff
public BoundPropertySetDiff()
-
BoundPropertySetDiff
public BoundPropertySetDiff(PropertySet copy)
-
-
Method Detail
-
modifiedBindings
protected java.util.Map<Property<?>,BoundValue> modifiedBindings()
-
isBound
public boolean isBound(Property<?> prop)
- Specified by:
isBound
in interfaceBoundPropertySet
-
isModified
public boolean isModified(Property<?> prop)
- Specified by:
isModified
in interfacePropertySetEdit
- Specified by:
isModified
in interfaceVersionedPropertySet
- Overrides:
isModified
in classPropertySetDiff
-
setBoundValue
public void setBoundValue(Property<?> prop, BoundValue value)
- Specified by:
setBoundValue
in interfaceBoundPropertySet
-
remove
public void remove(Property<?> prop)
- Specified by:
remove
in interfaceMutablePropertyValueSource
- Overrides:
remove
in classPropertySetDiff
-
setRaw
protected void setRaw(Property<?> prop, java.lang.Object value)
- Overrides:
setRaw
in classPropertySetDiff
-
getBoundValue
public BoundValue getBoundValue(Property<?> prop)
- Specified by:
getBoundValue
in interfaceBoundPropertySet
-
getBoundProperties
public java.util.Collection<Property<?>> getBoundProperties()
- Specified by:
getBoundProperties
in interfaceBoundPropertySet
-
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 interfacePropertySetEdit
- Overrides:
revert
in classPropertySetDiff
-
contains
public boolean contains(Property<?> prop)
- Specified by:
contains
in interfacePropertyValueSource
- Overrides:
contains
in classPropertySetDiff
- 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 interfaceCountable
- Overrides:
getCount
in classPropertySetDiff
-
hasChanges
public boolean hasChanges()
- Overrides:
hasChanges
in classPropertySetDiff
-
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 interfaceBoundPropertySet
- Specified by:
getValues
in interfacePropertyValueSource
- Overrides:
getValues
in classPropertySetDiff
-
-