Record Class ParameterSchema.ScalarField
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.ParameterSchema.ScalarField
- All Implemented Interfaces:
ParameterSchema.ParameterField
- Enclosing class:
ParameterSchema
public static record ParameterSchema.ScalarField(String name, String label, ParameterSchema.ScalarKind kind, @Nullable Object defaultValue, @Nullable Object minValue, @Nullable Object maxValue, boolean required)
extends Record
implements ParameterSchema.ParameterField
-
Constructor Summary
ConstructorsConstructorDescriptionScalarField(String name, String label, ParameterSchema.ScalarKind kind, @Nullable Object defaultValue, @Nullable Object minValue, @Nullable Object maxValue, boolean required) Creates an instance of aScalarFieldrecord class. -
Method Summary
Modifier and TypeMethodDescription@Nullable ObjectReturns 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.kind()Returns the value of thekindrecord component.label()Returns the value of thelabelrecord component.@Nullable ObjectmaxValue()Returns the value of themaxValuerecord component.@Nullable ObjectminValue()Returns the value of theminValuerecord 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.
-
Constructor Details
-
ScalarField
public ScalarField(String name, String label, ParameterSchema.ScalarKind kind, @Nullable Object defaultValue, @Nullable Object minValue, @Nullable Object maxValue, boolean required) Creates an instance of aScalarFieldrecord class.- Parameters:
name- the value for thenamerecord componentlabel- the value for thelabelrecord componentkind- the value for thekindrecord componentdefaultValue- the value for thedefaultValuerecord componentminValue- the value for theminValuerecord componentmaxValue- the value for themaxValuerecord 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
-
kind
Returns the value of thekindrecord component.- Returns:
- the value of the
kindrecord component
-
defaultValue
Returns the value of thedefaultValuerecord component.- Specified by:
defaultValuein interfaceParameterSchema.ParameterField- Returns:
- the value of the
defaultValuerecord component
-
minValue
Returns the value of theminValuerecord component.- Returns:
- the value of the
minValuerecord component
-
maxValue
Returns the value of themaxValuerecord component.- Returns:
- the value of the
maxValuerecord component
-
required
public boolean required()Returns the value of therequiredrecord component.- Specified by:
requiredin interfaceParameterSchema.ParameterField- Returns:
- the value of the
requiredrecord component
-