Package com.inductiveautomation.ignition.common.config

Class BasicPropertySet

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicPropertySet

All Implemented Interfaces:

Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, ObservablePropertySet, PropertySet, PropertyValueSource, Serializable, Iterable<PropertyValue>

Direct Known Subclasses:

AuthChallenge, BasicAlarmDefinition, BasicAlarmEvent, BasicBoundPropertySet, BasicUser, ChartUIElement, EventData, IdentityTraits, PipelineDescriptor, TagDefinition, TagEditResources

public class BasicPropertySet
extends Object
implements Serializable, ObservablePropertySet

A collection of properties and values.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicPropertySet.Builder

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
BasicPropertySet()
BasicPropertySet(PropertySet other)
BasicPropertySet(PropertySet other, boolean localOnly)
BasicPropertySet(PropertyValue... values)
BasicPropertySet(Map<? extends Property<?>,Object> copy)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(Property<?> property, PropertyChangeListener listener)
void	addPropertyChangeListener(PropertyChangeListener listener)
protected PropertyChangeSupport	change()	Returns this property set's property change support.
protected Object	coerceValue(Property<?> property, Object object)
boolean	contains(Property<?> prop)
boolean	equals(Object obj)
protected void	firePropertyChange(Property<?> property, Object oldValue, Object newValue)
<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> property, T value)	Get the value for a given Property, or else fall back to value if it's not present.
Collection<Property<?>>	getProperties()
protected Object	getRaw(Property<?> prop)
Map<Property<?>,Object>	getRawValueMap()
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.
Iterator<PropertyValue>	iterator()
static PropertySet	of(PropertyValue... values)
void	remove(Property<?> prop)
void	removePropertyChangeListener(Property<?> property, PropertyChangeListener listener)
void	removePropertyChangeListener(PropertyChangeListener listener)
<T> void	set(Property<T> prop, T value)
void	set(PropertyValue propValue)
void	setDirect(Property<?> p, Object value)	This function generally shouldn't be called by classes that do not extend.
protected void	setImpl(Property<?> property, Object object)
void	setRawValueMap(Map<? extends Property<?>,Object> copy)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

merge

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

merge

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

Constructor Details

BasicPropertySet

public BasicPropertySet()

BasicPropertySet

public BasicPropertySet(PropertyValue... values)

BasicPropertySet

public BasicPropertySet(PropertySet other)

BasicPropertySet

public BasicPropertySet(PropertySet other,
 boolean localOnly)

BasicPropertySet

public BasicPropertySet(Map<? extends Property<?>,Object> copy)

Method Details

of

public static PropertySet of(PropertyValue... values)

getRawValueMap

public Map<Property<?>,Object> getRawValueMap()

setRawValueMap

public void setRawValueMap(Map<? extends Property<?>,Object> copy)

getRaw

protected Object getRaw(Property<?> prop)

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. 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 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. Can return null if the value is null.

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

setImpl

protected void setImpl(Property<?> property,
 Object object)

coerceValue

protected Object coerceValue(Property<?> property,
 Object object)

setDirect

public void setDirect(Property<?> p,
 Object value)

This function generally shouldn't be called by classes that do not extend. However, for composite purposes, it needs to be public.

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 Collection<Property<?>> getProperties()

Specified by:

getProperties in interface PropertyValueSource

getValues

public 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

iterator

public Iterator<PropertyValue> iterator()

Specified by:

iterator in interface 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

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

change

protected PropertyChangeSupport change()

Returns this property set's property change support. Initializes on first call.

firePropertyChange

protected void firePropertyChange(Property<?> property,
 Object oldValue,
 Object newValue)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface ObservablePropertySet

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface ObservablePropertySet

addPropertyChangeListener

public void addPropertyChangeListener(Property<?> property,
 PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface ObservablePropertySet

removePropertyChangeListener

public void removePropertyChangeListener(Property<?> property,
 PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface ObservablePropertySet

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object