Record Class ParameterSchema.EnumField
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.ParameterSchema.EnumField
- All Implemented Interfaces:
ParameterSchema.ParameterField
- Enclosing class:
ParameterSchema
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription@Nullable StringReturns the value of thedefaultValuerecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.label()Returns the value of thelabelrecord component.name()Returns the value of thenamerecord component.booleanrequired()Returns the value of therequiredrecord component.final StringtoString()Returns a string representation of this record class.values()Returns the value of thevaluesrecord component.
-
Constructor Details
-
EnumField
public EnumField(String name, String label, List<String> values, @Nullable String defaultValue, boolean required) Creates an instance of aEnumFieldrecord class.- Parameters:
name- the value for thenamerecord componentlabel- the value for thelabelrecord componentvalues- the value for thevaluesrecord componentdefaultValue- the value for thedefaultValuerecord componentrequired- the value for therequiredrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
name
Returns the value of thenamerecord component.- Specified by:
namein interfaceParameterSchema.ParameterField- Returns:
- the value of the
namerecord component
-
label
Returns the value of thelabelrecord component.- Specified by:
labelin interfaceParameterSchema.ParameterField- Returns:
- the value of the
labelrecord component
-
values
-
defaultValue
Returns the value of thedefaultValuerecord component.- Specified by:
defaultValuein interfaceParameterSchema.ParameterField- Returns:
- the value of the
defaultValuerecord component
-
required
public boolean required()Returns the value of therequiredrecord component.- Specified by:
requiredin interfaceParameterSchema.ParameterField- Returns:
- the value of the
requiredrecord component
-