Package com.inductiveautomation.ignition.common.config

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

Field Summary

Fields

Modifier and Type	Field	Description
protected T	local
protected T	parent

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

EMPTY

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

Modifier and Type	Method	Description
boolean	contains(Property<?> prop)
<P> P	get(Property<P> 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 <P> P	getImpl(Property<P> prop, P orElse, boolean orDefault)
T	getLocal()
protected T	getOrCreateLocal()
<P> P	getOrDefault(Property<P> prop)
<P> P	getOrElse(Property<P> property, P value)	Get the value for a given Property, or else fall back to value if it's not present.
T	getParent()
<P> P	getParentProperty(Property<P> 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)
<P> void	set(Property<P> prop, P 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 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.PropertySet

extend, newDefaultInstance, newExtension

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

getNonNull, getNonNull, getValues

Field Detail

parent

@Nullable
protected T extends PropertySet parent

local

@Nullable
protected T extends PropertySet local

Constructor Detail

AbstractExtendedPropertySet

public AbstractExtendedPropertySet(@Nullable
                                   T local,
                                   @Nullable
                                   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

@Nullable
public T getLocal()

getParent

@Nullable
public T getParent()

setLocal

public void setLocal(@Nullable
                     T value)

setParent

public void setParent(@Nullable
                      T value)

getImpl

protected <P> P getImpl(Property<P> prop,
                        P orElse,
                        boolean orDefault)

get

public <P> P get(Property<P> 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 <P> P getOrDefault(Property<P> 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 <P> P getOrElse(Property<P> property,
                       P 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.

getParentProperty

public <P> P getParentProperty(Property<P> prop)

instantiateLocal

protected abstract T instantiateLocal()

getOrCreateLocal

protected T getOrCreateLocal()

set

public <P> void set(Property<P> prop,
                    P value)

Specified by:

set in interface MutablePropertyValueSource

set

public void set(PropertyValue propValue)

Specified by:

set in interface MutablePropertyValueSource

setImpl

protected void setImpl(Property prop,
                       java.lang.Object val)

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 PropertyValueSource

iterator

@Nonnull
public java.util.Iterator<PropertyValue> iterator()

Specified by:

iterator in interface java.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 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<T extends PropertySet>

Specified by:

getExtension in interface PropertySet

toString

public java.lang.String toString()

Overrides:

toString in class java.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 interface Mergable<T extends PropertySet>

Specified by:

merge in interface MutablePropertyValueSource