Package com.inductiveautomation.ignition.common.config

Interface Property<T>

All Superinterfaces:
Serializable
All Known Subinterfaces:
AlarmProperty<T>, ConfigurationProperty<T>, DescriptiveProperty<T>, NotificationProfileProperty<T>
All Known Implementing Classes:
AlarmModeProperties, AssociatedData, BasicAlarmProperty, BasicConfigurationProperty, BasicDescriptiveProperty, BasicNotificationProfileProperty, BasicProperty, CommonAlarmProperties, CommonAlarmProperties.CalculatedAlarmProperty, EventProperty, Parameter, RuntimeParameter, TagAttribute, TagProp, WellKnownAlarmProperties, ZoneTraitDescriptor
public interface Property<T> extends Serializable
A Property describes a unique name and datatype for a property.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    getDefaultValue()
    The default value for new instances of this property, or null if not applicable.
    String
    getName()
    The "name" of this property.
    Class<? extends T>
    getType()
    The data type for this property.

  • Method Details

    • getName

      String getName()
      The "name" of this property. Should be descriptive, but also unique. To this end, it is encouraged to make your keys fully qualified by prefixing them with your module id. For example: "mymod.MyProperty". Properties defined by the system start with "sys."

    • getType

      Class<? extends T> getType()
      The data type for this property.

    • getDefaultValue

      @Nullable T getDefaultValue()
      The default value for new instances of this property, or null if not applicable.