Class AssociatedData

    • Constructor Summary

      Constructors 
      Constructor Description
      AssociatedData​(java.lang.String name, java.lang.Class<?> dtype)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      LocalizedString getCategory()
      The category under which this property will be placed when editing.
      java.lang.Object getDefaultValue()
      The default value for new instances of this property, or null if not applicable.
      LocalizedString getDescription()
      Optional description/documentation for the property.
      LocalizedString getDisplayName()
      A friendly display name for the property.
      java.lang.String getName()
      The "name" of this property.
      java.lang.Class<? extends java.lang.Object> getType()
      The data type for this property.
      int hashCode()  
      boolean isAdvanced()
      Indicates whether this property should not be shown on basic edit screens.
      boolean isBindable()
      Indicates whether this property is allowed to be bound.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AssociatedData

        public AssociatedData​(java.lang.String name,
                              java.lang.Class<?> dtype)
    • Method Detail

      • getType

        public java.lang.Class<? extends java.lang.Object> getType()
        Description copied from interface: Property
        The data type for this property.
        Specified by:
        getType in interface Property<java.lang.Object>
      • getDefaultValue

        public java.lang.Object getDefaultValue()
        Description copied from interface: Property
        The default value for new instances of this property, or null if not applicable.
        Specified by:
        getDefaultValue in interface Property<java.lang.Object>
      • getName

        public java.lang.String getName()
        Description copied from interface: Property
        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."
        Specified by:
        getName in interface Property<java.lang.Object>
      • isBindable

        public boolean isBindable()
        Description copied from interface: AlarmProperty
        Indicates whether this property is allowed to be bound. If not, only simple values are allowed.
        Specified by:
        isBindable in interface AlarmProperty<java.lang.Object>
      • isAdvanced

        public boolean isAdvanced()
        Description copied from interface: AlarmProperty
        Indicates whether this property should not be shown on basic edit screens.
        Specified by:
        isAdvanced in interface AlarmProperty<java.lang.Object>
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object