PropertySetConfig

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AlarmDefinitionConfig, BoundPropertySetConfig
```
public class PropertySetConfig
extends java.lang.Object
implements VersionedPropertySet, PropertySetEdit
```
Like other Config entities, this object houses a source PropertySet and a Diff. Changes are made to the diff, and the diff is consulted first for retrieving values. The source object is consulted with the diff has no information for the property.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected PropertySetDiff edit

protected PropertySet source
- Fields inherited from interface com.inductiveautomation.ignition.common.config.VersionedPropertySet
  EMPTY

Fields
Modifier and Type	Field and Description
`protected PropertySetDiff`	`edit`
`protected PropertySet`	`source`

Constructor Summary

Constructors
Constructor and Description

PropertySetConfig(PropertySet source)

PropertySetConfig(PropertySet source, PropertySetDiff editTarget)

Constructors
Constructor and Description
`PropertySetConfig(PropertySet source)`
`PropertySetConfig(PropertySet source, PropertySetDiff editTarget)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Property<?> prop)`
`static PropertySetConfig`	`create(PropertySet source)` Returns a wrapping PropertySetConfig, unless the source already is one, then just casts it.
`protected PropertySetDiff`	`createDiff()`
`void`	`discardChanges()`
`<T> T`	`get(Property<T> prop)` Retrieves the value of the property, or `null` if this set doesn't contain that property.
`int`	`getCount()`
`PropertySetDiff`	`getEdit()`
`java.util.Set<Property<?>>`	`getModified()`
`<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.
`java.util.Collection<Property<?>>`	`getProperties()`
`PropertySet`	`getSource()`
`protected <T> T`	`getSuperValue(Property<T> prop)`
`java.util.List<PropertyValue>`	`getValues()`
`protected boolean`	`goToSuper(Property<?> prop)`
`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.
`boolean`	`isModified(Property<?> property)`
`protected boolean`	`isRemoved(Property<?> prop)`
`java.util.Iterator<PropertyValue>`	`iterator()`
`void`	`mergeDiffToSource()`
`void`	`remove(Property<?> prop)`
`void`	`revert(Property<?> prop)`
`<T> void`	`set(Property<T> prop, T value)`
`void`	`set(PropertyValue propValue)`
`protected void`	`setImpl(Property prop, java.lang.Object val)`

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
builder, extend, getExtension, newDefaultInstance, newExtension

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource
merge

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable
merge

- Field Detail
  - source
```
protected PropertySet source
```
  - edit
```
protected PropertySetDiff edit
```
- Constructor Detail
  - PropertySetConfig
```
public PropertySetConfig(PropertySet source,
                         PropertySetDiff editTarget)
```
  - PropertySetConfig
```
public PropertySetConfig(PropertySet source)
```
- Method Detail
  - create
```
public static PropertySetConfig create(PropertySet source)
```
    Returns a wrapping PropertySetConfig, unless the source already is one, then just casts it.
  - getSource
```
public PropertySet getSource()
```
  - getEdit
```
public PropertySetDiff getEdit()
```
  - createDiff
```
protected PropertySetDiff createDiff()
```
  - mergeDiffToSource
```
public void mergeDiffToSource()
```
  - discardChanges
```
public void discardChanges()
```
  - getModified
```
public java.util.Set<Property<?>> getModified()
```
    Specified by:
    
    getModified in interface VersionedPropertySet
  - 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
  - getSuperValue
```
protected <T> T getSuperValue(Property<T> prop)
```
  - goToSuper
```
protected boolean goToSuper(Property<?> 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> 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.
  - setImpl
```
protected void setImpl(Property prop,
                       java.lang.Object val)
```
  - 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
  - revert
```
public void revert(Property<?> prop)
```
    Specified by:
    
    revert in interface PropertySetEdit
  - 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
  - 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
  - isModified
```
public boolean isModified(Property<?> property)
```
    Specified by:
    
    isModified in interface PropertySetEdit
    
    Specified by:
    
    isModified in interface VersionedPropertySet
  - getProperties
```
public java.util.Collection<Property<?>> getProperties()
```
    Specified by:
    
    getProperties in interface PropertyValueSource
  - getValues
```
public java.util.List<PropertyValue> getValues()
```
    Specified by:
    
    getValues in interface PropertyValueSource
  - iterator
```
public java.util.Iterator<PropertyValue> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<PropertyValue>
  - isRemoved
```
protected boolean isRemoved(Property<?> prop)
```

Class PropertySetConfig

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

Field Detail

source

edit

Constructor Detail

PropertySetConfig

PropertySetConfig

Method Detail

create

getSource

getEdit

createDiff

mergeDiffToSource

discardChanges

getModified

get

getSuperValue

goToSuper

getOrDefault

getOrElse

setImpl

set

set

remove

revert

contains

getCount

isExtended

isInherited

isModified

getProperties

getValues

iterator

isRemoved