Interface PropertySet
-
- All Superinterfaces:
Countable
,Extendable<PropertySet>
,java.lang.Iterable<PropertyValue>
,Mergable<PropertySet>
,MutablePropertyValueSource
,PropertyValueSource
,java.io.Serializable
- All Known Subinterfaces:
AlarmDefinition
,AlarmEvent
,AuthenticatedUser
,BoundPropertySet
,NotificationContext
,ObservablePropertySet
,PropertySetEdit
,QualifiedValuePropertySet
,TagConfiguration
,TagConfigurationModel
,TagEditController<T>
,TagGroup
,User
,VersionedPropertySet
- All Known Implementing Classes:
AbstractExtendedPropertySet
,ADSSOAuthChallenge
,AlarmDefinitionConfig
,AlarmDefinitionDiff
,AlarmEventInstance
,AuthChallenge
,BadgeAuthChallenge
,BasicAlarmDefinition
,BasicAlarmEvent
,BasicAuthChallenge
,BasicAuthenticatedUser
,BasicBoundPropertySet
,BasicPropertySet
,BasicTagConfiguration
,BasicTagConfigurationModel
,BasicTagEditController
,BasicUser
,BasicVersionedPropertySet
,BoundExtendedPropertySet
,BoundPropertySetConfig
,BoundPropertySetDiff
,ChartUIElement
,ComplexTagDefinition
,ComplexTagDiff
,CompositePropertySet
,DelegatePropertySet
,EventData
,ExtendedAlarmDefinition
,ExtendedPropertySet
,IdentityTraits
,ImmutablePropertySet
,IntersectedAlarmDefinition
,IntersectedBoundPropertySet
,IntersectedPropertySet
,IntersectedTagConfig
,IntersectedTagEditModel
,PipelineDescriptor
,PropertySetConfig
,PropertySetDiff
,PyAlarmEventImpl
,PyUser
,StorageTagConfiguration
,TagDefinition
,TagDiff
,TagEditResources
,TagPropertySetWrapper
,UnfilteredEventData
public interface PropertySet extends java.io.Serializable, java.lang.Iterable<PropertyValue>, MutablePropertyValueSource, Countable, Extendable<PropertySet>
A PropertySet is a collection of property values. It is mutable, but extends from PropertyValueSource, which is read-only.
-
-
Field Summary
Fields Modifier and Type Field Description static ImmutablePropertySet
EMPTY
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static BasicPropertySet.Builder
builder()
default PropertySet
extend(PropertySet parent)
If called on a child, gets the extension with the given parent.default PropertySet
getExtension()
This returns an object that represents the value only for the most "local" level.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.default PropertySet
newDefaultInstance()
default PropertySet
newExtension()
Called on a base object, gets a new extension with a default config object for the child.-
Methods inherited from interface com.inductiveautomation.ignition.common.config.MutablePropertyValueSource
merge, remove, set, set
-
Methods inherited from interface com.inductiveautomation.ignition.common.config.PropertyValueSource
contains, get, getNonNull, getNonNull, getOrDefault, getOrElse, getProperties, getValues
-
-
-
-
Field Detail
-
EMPTY
static final ImmutablePropertySet EMPTY
-
-
Method Detail
-
newExtension
default PropertySet newExtension()
Description copied from interface:Extendable
Called on a base object, gets a new extension with a default config object for the child.- Specified by:
newExtension
in interfaceExtendable<PropertySet>
-
extend
default PropertySet extend(PropertySet parent)
Description copied from interface:Extendable
If called on a child, gets the extension with the given parent.- Specified by:
extend
in interfaceExtendable<PropertySet>
-
newDefaultInstance
default PropertySet newDefaultInstance()
-
getExtension
default 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 interfaceExtendable<PropertySet>
-
builder
static BasicPropertySet.Builder builder()
-
isExtended
boolean isExtended(Property<?> prop)
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.
-
isInherited
boolean isInherited(Property<?> prop)
Indicates whether the property was inherited from a parent type.
-
-