IntersectedPropertySet

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

All Implemented Interfaces:

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

Direct Known Subclasses:

IntersectedTagConfig
```
public class IntersectedPropertySet
extends java.lang.Object
implements PropertySet
```
Represents an intersection of propertysets. Modification operations happen on all underlying sets. Functions such as the interator, contains, and getProperties only apply to properties that intersect cleanly (in other words, are the same across all sets).
The class calculates the intersectable properties on construction, so changes to the underlying propertysets will not be visible unless refresh() is called. Changes made through this class, however, are tracked, so it won't normally be necessary to call refresh().

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IntersectedPropertySet(java.util.List<? extends PropertySet> propertySets)

Constructors
Constructor and Description
`IntersectedPropertySet(java.util.List<? extends PropertySet> propertySets)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Property<?> prop)`
`<T> T`	`get(Property<T> prop)` Returns the intersected value, or null if the values don't match or the property isn't present.
`int`	`getCount()`
`protected java.util.Set<Property<?>>`	`getIntersectableProperties()`
`<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()`
`protected java.util.List<? extends PropertySet>`	`internalObjects()`
`protected <T> T`	`intersect(Property<T> prop, T fallback)`
`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.
`protected <T> boolean`	`isPropSubsectable(Property<T> prop)`
`java.util.Iterator<PropertyValue>`	`iterator()`
`void`	`merge(PropertySet other)` Merges the values from other collection into this one.
`void`	`refresh()` Recalculates the intersection.
`void`	`remove(Property<?> prop)`
`<T> void`	`set(Property<T> prop, T value)`
`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 java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - IntersectedPropertySet
```
public IntersectedPropertySet(java.util.List<? extends PropertySet> propertySets)
```
- Method Detail
  - refresh
```
public void refresh()
```
    Recalculates the intersection. Should be called when underlying data changes. Modifications to the property sets through this class do not require refresh() to be called, they are tracked separately.
  - internalObjects
```
protected java.util.List<? extends PropertySet> internalObjects()
```
  - iterator
```
public java.util.Iterator<PropertyValue> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<PropertyValue>
  - get
```
public <T> T get(Property<T> prop)
```
    Returns the intersected value, or null if the values don't match or the property isn't present.
    
    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.
  - 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> 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.
  - intersect
```
protected <T> T intersect(Property<T> prop,
                          T fallback)
```
  - isPropSubsectable
```
protected <T> boolean isPropSubsectable(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
  - 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
  - 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
  - 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>
  - getIntersectableProperties
```
protected java.util.Set<Property<?>> getIntersectableProperties()
```

Class IntersectedPropertySet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

IntersectedPropertySet

Method Detail

refresh

internalObjects

iterator

get

contains

getOrDefault

getOrElse

intersect

isPropSubsectable

set

set

remove

getCount

getProperties

getValues

isExtended

isInherited

merge

getIntersectableProperties