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

public static record ParameterSchema.EnumField(String name, String label, List<String> values, @Nullable String defaultValue, boolean required) extends Record implements ParameterSchema.ParameterField
  • Constructor Summary

    Constructors
    Constructor
    Description
    EnumField(String name, String label, List<String> values, @Nullable String defaultValue, boolean required)
    Creates an instance of a EnumField record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    Returns the value of the defaultValue record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the label record component.
    Returns the value of the name record component.
    boolean
    Returns the value of the required record component.
    final String
    Returns a string representation of this record class.
    Returns the value of the values record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • EnumField

      public EnumField(String name, String label, List<String> values, @Nullable String defaultValue, boolean required)
      Creates an instance of a EnumField record class.
      Parameters:
      name - the value for the name record component
      label - the value for the label record component
      values - the value for the values record component
      defaultValue - the value for the defaultValue record component
      required - the value for the required record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      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 with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface ParameterSchema.ParameterField
      Returns:
      the value of the name record component
    • label

      public String label()
      Returns the value of the label record component.
      Specified by:
      label in interface ParameterSchema.ParameterField
      Returns:
      the value of the label record component
    • values

      public List<String> values()
      Returns the value of the values record component.
      Returns:
      the value of the values record component
    • defaultValue

      public @Nullable String defaultValue()
      Returns the value of the defaultValue record component.
      Specified by:
      defaultValue in interface ParameterSchema.ParameterField
      Returns:
      the value of the defaultValue record component
    • required

      public boolean required()
      Returns the value of the required record component.
      Specified by:
      required in interface ParameterSchema.ParameterField
      Returns:
      the value of the required record component