Class AbstractExtendedPropertySet<T extends PropertySet>
- java.lang.Object
-
- com.inductiveautomation.ignition.common.config.AbstractExtendedPropertySet<T>
-
- All Implemented Interfaces:
Countable
,Extendable<PropertySet>
,Mergable<PropertySet>
,MutablePropertyValueSource
,PropertySet
,PropertyValueSource
,java.io.Serializable
,java.lang.Iterable<PropertyValue>
- Direct Known Subclasses:
BoundExtendedPropertySet
,ExtendedPropertySet
public abstract class AbstractExtendedPropertySet<T extends PropertySet> extends java.lang.Object implements PropertySet
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractExtendedPropertySet()
Protected, because only sub classes can set the data.AbstractExtendedPropertySet(T local, T parent)
Use the static function if you want to optionally create this only when necessary.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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.int
getCount()
PropertySet
getExtension()
This returns an object that represents the value only for the most "local" level.protected <T> T
getImpl(Property<T> prop, T orElse, boolean orDefault)
T
getLocal()
protected T
getOrCreateLocal()
<T> T
getOrDefault(Property<T> prop)
<T> T
getOrElse(Property<T> property, T value)
Get the value for a givenProperty
, or else fall back to value if it's not present.T
getParent()
<T> T
getParentProperty(Property<T> prop)
java.util.Collection<Property<?>>
getProperties()
protected abstract T
instantiateLocal()
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, boolean localDefinitionsOnly)
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)
protected void
setImpl(Property prop, java.lang.Object val)
void
setLocal(T value)
void
setParent(T value)
java.lang.String
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.PropertySet
extend, newDefaultInstance, newExtension
-
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource
getNonNull, getNonNull, getValues
-
-
-
-
Field Detail
-
parent
protected T extends PropertySet parent
-
local
protected T extends PropertySet local
-
-
Constructor Detail
-
AbstractExtendedPropertySet
public AbstractExtendedPropertySet(T local, T parent)
Use the static function if you want to optionally create this only when necessary.
-
AbstractExtendedPropertySet
protected AbstractExtendedPropertySet()
Protected, because only sub classes can set the data.
-
-
Method Detail
-
getLocal
public T getLocal()
-
getParent
public T getParent()
-
setLocal
public void setLocal(T value)
-
setParent
public void setParent(T value)
-
getImpl
protected <T> T getImpl(Property<T> prop, T orElse, boolean orDefault)
-
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 interfacePropertyValueSource
-
getOrDefault
public <T> T getOrDefault(Property<T> prop)
- Specified by:
getOrDefault
in interfacePropertyValueSource
- 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 givenProperty
, or else fall back to value if it's not present.- Specified by:
getOrElse
in interfacePropertyValueSource
- Parameters:
property
- 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.
-
getParentProperty
public <T> T getParentProperty(Property<T> prop)
-
instantiateLocal
protected abstract T instantiateLocal()
-
getOrCreateLocal
protected T getOrCreateLocal()
-
set
public <T> void set(Property<T> prop, T value)
- Specified by:
set
in interfaceMutablePropertyValueSource
-
set
public void set(PropertyValue propValue)
- Specified by:
set
in interfaceMutablePropertyValueSource
-
setImpl
protected void setImpl(Property prop, java.lang.Object val)
-
remove
public void remove(Property<?> prop)
- Specified by:
remove
in interfaceMutablePropertyValueSource
-
contains
public boolean contains(Property<?> prop)
- Specified by:
contains
in interfacePropertyValueSource
- Returns:
- True if the source contains a value for prop.
-
getProperties
public java.util.Collection<Property<?>> getProperties()
- Specified by:
getProperties
in interfacePropertyValueSource
-
iterator
@Nonnull public java.util.Iterator<PropertyValue> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<T extends PropertySet>
-
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 interfacePropertySet
-
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 interfacePropertySet
-
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 interfaceExtendable<T extends PropertySet>
- Specified by:
getExtension
in interfacePropertySet
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
merge
public void merge(PropertySet other, boolean localDefinitionsOnly)
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<T extends PropertySet>
- Specified by:
merge
in interfaceMutablePropertyValueSource
-
-