Class ImmutablePropertySet
java.lang.Object
com.inductiveautomation.ignition.common.config.ImmutablePropertySet
- All Implemented Interfaces:
Countable
,Extendable<PropertySet>
,Mergable<PropertySet>
,MutablePropertyValueSource
,PropertySet
,PropertyValueSource
,Serializable
,Iterable<PropertyValue>
- See Also:
-
Field Summary
Fields inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
EMPTY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
extend
(PropertySet parent) If called on a child, gets the extension with the given parent.void
forEach
(Consumer<? super PropertyValue> action) <T> T
Retrieves the value of the property, or null if this set doesn't contain that property.int
getCount()
This returns an object that represents the value only for the most "local" level.<T> T
getOrDefault
(Property<T> prop) <T> T
Get the value for a givenProperty
, or else fall back to value if it's not present.Collection<Property<?>>
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.iterator()
void
merge
(PropertySet other) void
merge
(PropertySet other, boolean local) Merges the values from other collection into this one.void
<T> void
void
set
(PropertyValue propValue) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertySet
newDefaultInstance, newExtension
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource
getNonNull, getNonNull
-
Constructor Details
-
ImmutablePropertySet
public ImmutablePropertySet() -
ImmutablePropertySet
-
-
Method Details
-
merge
- Specified by:
merge
in interfaceMergable<PropertySet>
-
merge
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 interfaceMergable<PropertySet>
- Specified by:
merge
in interfaceMutablePropertyValueSource
-
set
- Specified by:
set
in interfaceMutablePropertyValueSource
-
set
- Specified by:
set
in interfaceMutablePropertyValueSource
-
getCount
public int getCount() -
remove
- Specified by:
remove
in interfaceMutablePropertyValueSource
-
get
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 interfacePropertyValueSource
-
contains
- Specified by:
contains
in interfacePropertyValueSource
- Returns:
- True if the source contains a value for prop.
-
getProperties
- Specified by:
getProperties
in interfacePropertyValueSource
-
getOrDefault
- Specified by:
getOrDefault
in interfacePropertyValueSource
- Returns:
- The value for prop or
Property.getDefaultValue()
if not present. Can return null if the value is null.
-
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 interfacePropertyValueSource
-
extend
Description copied from interface:Extendable
If called on a child, gets the extension with the given parent.- Specified by:
extend
in interfaceExtendable<PropertySet>
- Specified by:
extend
in interfacePropertySet
-
iterator
- Specified by:
iterator
in interfaceIterable<PropertyValue>
-
getOrElse
Description copied from interface:PropertyValueSource
Get the value for a givenProperty
, or else fall back to value if it's not present.- Specified by:
getOrElse
in interfacePropertyValueSource
- Parameters:
prop
- TheProperty
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.
-
getExtension
Description copied from interface:Extendable
This returns an object that represents the value only for the most "local" level. That is, this is the difference between the inherited base and the current extension. Complex objects should ensure that trait is true for all aspects of the returned value.- Specified by:
getExtension
in interfaceExtendable<PropertySet>
- Specified by:
getExtension
in interfacePropertySet
-
forEach
- Specified by:
forEach
in interfaceIterable<PropertyValue>
-
isExtended
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 interfacePropertySet
-
isInherited
Description copied from interface:PropertySet
Indicates whether the property was inherited from a parent type.- Specified by:
isInherited
in interfacePropertySet
-
spliterator
- Specified by:
spliterator
in interfaceIterable<PropertyValue>
-