Class WellKnownAlarmProperties<T>
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alarming.config.WellKnownAlarmProperties<T>
-
- All Implemented Interfaces:
AlarmProperty<T>
,DescriptiveProperty<T>
,Property<T>
,java.io.Serializable
- Direct Known Subclasses:
AlarmModeProperties
,CommonAlarmProperties
public abstract class WellKnownAlarmProperties<T> extends java.lang.Object implements AlarmProperty<T>
This class is used as a base for enum-like static definitions of AlarmProperties. This is to create objects that are very much like enums, but with full generic type support. In particular, it supports name() and values(), the latter of which will reflectively look for statically defined members in the derived class.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description WellKnownAlarmProperties()
Only for serialization.protected
WellKnownAlarmProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal)
protected
WellKnownAlarmProperties(java.lang.String simpleName, java.lang.Class<T> dtype, T defaultVal, boolean bindable)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
T
getDefaultValue()
The default value for new instances of this property, or null if not applicable.java.lang.String
getName()
The "name" of this property.java.lang.Class<T>
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.java.lang.String
name()
java.lang.String
toString()
protected static AlarmProperty<?>[]
values(java.lang.Class<? extends WellKnownAlarmProperties> c)
Can be called by an implementation of values() in sub classes to dynamically get the declared static fields.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.common.config.DescriptiveProperty
getCategory, getDescription, getDisplayName
-
-
-
-
Method Detail
-
name
public java.lang.String name()
-
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."
-
getType
public java.lang.Class<T> getType()
Description copied from interface:Property
The data type for this property.
-
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 interfaceAlarmProperty<T>
-
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 interfaceAlarmProperty<T>
-
getDefaultValue
public T getDefaultValue()
Description copied from interface:Property
The default value for new instances of this property, or null if not applicable.- Specified by:
getDefaultValue
in interfaceProperty<T>
-
values
protected static AlarmProperty<?>[] values(java.lang.Class<? extends WellKnownAlarmProperties> c)
Can be called by an implementation of values() in sub classes to dynamically get the declared static fields.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-