Package com.inductiveautomation.ignition.common.config

Interface PropertySet

All Superinterfaces:
Countable, Extendable<PropertySet>, Iterable<PropertyValue>, Mergable<PropertySet>, MutablePropertyValueSource, PropertyValueSource, Serializable
All Known Subinterfaces:
AlarmDefinition, AlarmEvent, AuthenticatedUser, BoundPropertySet, NotificationContext, ObservablePropertySet, PropertySetEdit, PyAlarmEvent, QualifiedValuePropertySet, TagConfiguration, TagConfigurationModel, TagEditController<T>, TagGroup, User, VersionedPropertySet
All Known Implementing Classes:
AbstractExtendedPropertySet, AlarmDefinitionConfig, AlarmDefinitionDiff, AlarmEventInstance, 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 Serializable, 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 Details

  • Method Details

    • 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 interface Extendable<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 interface Extendable<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 interface Extendable<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.

    • isEmpty

      static boolean isEmpty(@Nullable PropertySet set)
      Determines whether a given PropertySet is empty.
      Parameters:
      set - the PropertySet to evaluate; may be null.
      Returns:
      true if the PropertySet is null or contains no elements; false otherwise.

    • isNotEmpty

      static boolean isNotEmpty(@Nullable PropertySet set)
      Checks if the given PropertySet is not empty.
      Parameters:
      set - the PropertySet to evaluate; may be null.
      Returns:
      true if the PropertySet is not null and contains at least one element; false otherwise.