com.inductiveautomation.ignition.common.config

Class BasicConfigurationPropertyModel.InternalProperty<T>

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicConfigurationPropertyModel.InternalProperty<T>

All Implemented Interfaces:

BasicConfigurationPropertyModel.RankedProperty, java.io.Serializable

Enclosing class:

BasicConfigurationPropertyModel

protected class BasicConfigurationPropertyModel.InternalProperty<T>
extends java.lang.Object
implements java.io.Serializable, BasicConfigurationPropertyModel.RankedProperty

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InternalProperty(Property<T> prop)

Method Summary

Modifier and Type	Method and Description
void	addDependantProperty(T value, BasicConfigurationPropertyModel.InternalProperty<?> property)
void	dependentOn(BasicConfigurationPropertyModel.InternalProperty<?> p)
java.util.Optional<java.util.Collection<T>>	getAllowedValues() Returns the specified allowed values first, then the implicit values if keyed models are registered, otherwise empty optional.
void	getDependantProperties(java.util.Set<BasicConfigurationPropertyModel.InternalProperty<?>> retVal)
void	getEditableProperties(PropertySet config, java.util.Set<BasicConfigurationPropertyModel.RankedProperty> retValues, java.util.Set<BasicConfigurationPropertyModel.InternalProperty<?>> visited)
Property<T>	getProperty()
int	getRank()
boolean	isApplicable(PropertySet config) Return true if this property is applicable for the config.
protected boolean	isChildApplicable(PropertySet config, BasicConfigurationPropertyModel.InternalProperty<?> prop) This is for checking dependencies from the bottom up.
boolean	isDependant()
boolean	isImmutable()
void	markImmutable()
protected void	mergeTo(MutableConfigurationPropertyModel target)
void	registerAllowedValues(java.util.List<T> values)
void	removeDependantProperties(T value)
void	setAllowedValues(java.util.List<T> values)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalProperty

public InternalProperty(Property<T> prop)

Method Detail

getProperty

public Property<T> getProperty()

Specified by:

getProperty in interface BasicConfigurationPropertyModel.RankedProperty

getRank

public int getRank()

Specified by:

getRank in interface BasicConfigurationPropertyModel.RankedProperty

isImmutable

public boolean isImmutable()

markImmutable

public void markImmutable()

dependentOn

public void dependentOn(BasicConfigurationPropertyModel.InternalProperty<?> p)

isDependant

public boolean isDependant()

mergeTo

protected void mergeTo(MutableConfigurationPropertyModel target)

getAllowedValues

public java.util.Optional<java.util.Collection<T>> getAllowedValues()

Returns the specified allowed values first, then the implicit values if keyed models are registered, otherwise empty optional.

setAllowedValues

public void setAllowedValues(java.util.List<T> values)

registerAllowedValues

public void registerAllowedValues(java.util.List<T> values)

getEditableProperties

public void getEditableProperties(PropertySet config,
                                  java.util.Set<BasicConfigurationPropertyModel.RankedProperty> retValues,
                                  java.util.Set<BasicConfigurationPropertyModel.InternalProperty<?>> visited)

getDependantProperties

public void getDependantProperties(java.util.Set<BasicConfigurationPropertyModel.InternalProperty<?>> retVal)

addDependantProperty

public void addDependantProperty(T value,
                                 BasicConfigurationPropertyModel.InternalProperty<?> property)

removeDependantProperties

public void removeDependantProperties(T value)

isApplicable

public boolean isApplicable(PropertySet config)

Return true if this property is applicable for the config.

isChildApplicable

protected boolean isChildApplicable(PropertySet config,
                                    BasicConfigurationPropertyModel.InternalProperty<?> prop)

This is for checking dependencies from the bottom up. In order for a prop to be valid, its parent must have it as a valid dependency. For that to be true, it must be in the set of props for the current value of the parent prop.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object