Package com.inductiveautomation.ignition.designer.sqltags.editor

Class TagPropertySetWrapper

java.lang.Object
com.inductiveautomation.ignition.designer.sqltags.editor.TagPropertySetWrapper
All Implemented Interfaces:
Countable, Extendable<PropertySet>, Mergable<PropertySet>, MutablePropertyValueSource, PropertySet, PropertyValueSource, Serializable, Iterable<PropertyValue>
public class TagPropertySetWrapper extends Object implements PropertySet
Wraps a tag as a property set. Should be created through the static createPropertySet() function, which will check to see if the incoming tag is already a property set.
See Also:

  • Method Details

    • isEditable

      protected boolean isEditable()

    • edit

      protected MutableTag edit()

    • createPropertySet

      public static PropertySet createPropertySet(Tag tag)
      Wraps a tag as a property set. If the incoming object is a version of Tag that is already a property set, it will be returned directly.

    • iterator

      public Iterator<PropertyValue> iterator()
      Specified by:
      iterator in interface Iterable<PropertyValue>

    • _set

      protected void _set(Property<?> prop, Object value)

    • 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

    • remove

      public void remove(Property<?> prop)
      Specified by:
      remove in interface MutablePropertyValueSource

    • merge

      public void merge(PropertySet other)
      Specified by:
      merge in interface Mergable<PropertySet>

    • 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

    • contains

      public boolean contains(Property<?> prop)
      Specified by:
      contains in interface PropertyValueSource
      Returns:
      True if the source contains a value for prop.

    • 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> prop, 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:
      prop - 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.

    • 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

    • 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