Package com.inductiveautomation.ignition.common.config

Class ImmutablePropertySet

java.lang.Object

com.inductiveautomation.ignition.common.config.ImmutablePropertySet

All Implemented Interfaces:

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

public class ImmutablePropertySet
extends java.lang.Object
implements PropertySet

See Also:

Serialized Form

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ImmutablePropertySet()
ImmutablePropertySet(PropertySet internal)

Method Summary

Modifier and Type	Method	Description
boolean	contains(Property<?> prop)
PropertySet	extend(PropertySet parent)	If called on a child, gets the extension with the given parent.
void	forEach(java.util.function.Consumer<? super PropertyValue> action)
<T> T	get(Property<T> prop)	Retrieves the value of the property, or null if this set doesn't contain that property.
int	getCount()
PropertySet	getExtension()	This returns an object that represents the value only for the most "local" level.
<T> T	getOrDefault(Property<T> prop)
<T> T	getOrElse(Property<T> prop, 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.
java.util.Iterator<PropertyValue>	iterator()
void	merge(PropertySet other)
void	merge(PropertySet other, boolean local)	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)
java.util.Spliterator<PropertyValue>	spliterator()

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 Detail

ImmutablePropertySet

public ImmutablePropertySet()

ImmutablePropertySet

public ImmutablePropertySet(PropertySet internal)

Method Detail

merge

public void merge(PropertySet other)

Specified by:

merge in interface Mergable<PropertySet>

merge

public void merge(PropertySet other,
                  boolean local)

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

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

getCount

public int getCount()

Specified by:

getCount in interface Countable

remove

public void remove(Property<?> prop)

Specified by:

remove in interface MutablePropertyValueSource

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

contains

public boolean contains(Property<?> prop)

Specified by:

contains in interface PropertyValueSource

Returns:

True if the source contains a value for prop.

getProperties

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

Specified by:

getProperties in interface PropertyValueSource

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.

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

extend

public PropertySet extend(PropertySet parent)

Description copied from interface: Extendable

If called on a child, gets the extension with the given parent.

Specified by:

extend in interface Extendable<PropertySet>

Specified by:

extend in interface PropertySet

iterator

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

Specified by:

iterator in interface java.lang.Iterable<PropertyValue>

getOrElse

public <T> T getOrElse(Property<T> prop,
                       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:

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

getExtension

public PropertySet 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 interface Extendable<PropertySet>

Specified by:

getExtension in interface PropertySet

forEach

public void forEach(java.util.function.Consumer<? super PropertyValue> action)

Specified by:

forEach 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

spliterator

public java.util.Spliterator<PropertyValue> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<PropertyValue>