ExtendedPropertySet

java.lang.Object
- com.inductiveautomation.ignition.common.config.ExtendedPropertySet

All Implemented Interfaces:

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

Direct Known Subclasses:

ExtendedAlarmDefinition, OverrideMutatingConfigObject
```
public class ExtendedPropertySet
extends java.lang.Object
implements PropertySet
```
A property set that actually consists of two sets- a local one, and it's "parent". Values will be pulled from local first, and parent if they don't exist in local. Parent is never modified, all changes only apply to local.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ExtendedPropertySet()` Protected, because only sub classes can set the data.
`protected`	`ExtendedPropertySet(PropertySet local, PropertySet parent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Property<?> prop)`
`static PropertySet`	`extend(PropertySet parent, PropertySet extension)` Creates a new property set that is the extension on top of the parent.
`<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`	`getLocal()`
`<T> T`	`getOrDefault(Property<T> prop)`
`<T> T`	`getOrElse(Property<T> property, T value)` Get the value for a given `Property`, or else fall back to `value` if it's not present.
`PropertySet`	`getParent()`
`<T> T`	`getParentProperty(Property<T> prop)`
`java.util.Collection<Property<?>>`	`getProperties()`
`java.util.List<PropertyValue>`	`getValues()`
`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)` 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`	`setLocal(PropertySet value)`
`protected void`	`setParent(PropertySet 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 java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ExtendedPropertySet
```
protected ExtendedPropertySet(PropertySet local,
                              PropertySet parent)
```
  - ExtendedPropertySet
```
protected ExtendedPropertySet()
```
    Protected, because only sub classes can set the data.
- Method Detail
  - getLocal
```
public PropertySet getLocal()
```
  - getParent
```
public PropertySet getParent()
```
  - setLocal
```
protected void setLocal(PropertySet value)
```
  - setParent
```
protected void setParent(PropertySet value)
```
  - 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
  - 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.
  - getOrElse
```
public <T> T getOrElse(Property<T> property,
                       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:
    
    property - 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.
  - getParentProperty
```
public <T> T getParentProperty(Property<T> prop)
```
  - 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
  - remove
```
public void remove(Property<?> prop)
```
    Specified by:
    
    remove in interface MutablePropertyValueSource
  - contains
```
public boolean contains(Property<?> prop)
```
    Specified by:
    
    contains in interface PropertyValueSource
    
    Returns:
    
    True if the source contains a value for prop.
  - getCount
```
public int getCount()
```
    Specified by:
    
    getCount in interface Countable
  - getProperties
```
public java.util.Collection<Property<?>> getProperties()
```
    Specified by:
    
    getProperties in interface PropertySet
  - getValues
```
public java.util.List<PropertyValue> getValues()
```
    Specified by:
    
    getValues in interface PropertySet
  - iterator
```
public java.util.Iterator<PropertyValue> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<PropertyValue>
  - extend
```
public static PropertySet extend(PropertySet parent,
                                 PropertySet extension)
```
    Creates a new property set that is the extension on top of the parent. If the parent is null, the extension is returned directly, otherwise an ExtensionPropertySet is returned. That object will instantiate a new basic property set if local happens to be null.
  - isExtended
```
public boolean isExtended(Property<?> prop)
```
    Description copied from interface: PropertyValueSource
    
    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 PropertyValueSource
  - isInherited
```
public boolean isInherited(Property<?> prop)
```
    Description copied from interface: PropertyValueSource
    
    Indicates whether the property was inherited from a parent type.
    
    Specified by:
    
    isInherited in interface PropertyValueSource
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - merge
```
public void merge(PropertySet other)
```
    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>

Class ExtendedPropertySet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ExtendedPropertySet

ExtendedPropertySet

Method Detail

getLocal

getParent

setLocal

setParent

get

getOrDefault

getOrElse

getParentProperty

set

set

remove

contains

getCount

getProperties

getValues

iterator

extend

isExtended

isInherited

toString

merge