Package org.pjdbc.capabilities

Record Class DriverCapability.Parameter

java.lang.Object
java.lang.Record
org.pjdbc.capabilities.DriverCapability.Parameter
Enclosing class:
DriverCapability
public static record DriverCapability.Parameter(String name, String type, String description, Object defaultValue, boolean required, Number min, Number max, List<String> enumValues) extends Record
Represents a configurable driver parameter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Parameter(String name, String type, String description, Object defaultValue, boolean required, Number min, Number max, List<String> enumValues)
    Creates an instance of a Parameter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    defaultValue()
    Returns the value of the defaultValue record component.
    String
    description()
    Returns the value of the description record component.
    List<String>
    enumValues()
    Returns the value of the enumValues record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Number
    max()
    Returns the value of the max record component.
    Number
    min()
    Returns the value of the min record component.
    String
    name()
    Returns the value of the name record component.
    boolean
    required()
    Returns the value of the required record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Parameter

      public Parameter(String name, String type, String description, Object defaultValue, boolean required, Number min, Number max, List<String> enumValues)
      Creates an instance of a Parameter record class.
      Parameters:
      name - the value for the name record component
      type - the value for the type record component
      description - the value for the description record component
      defaultValue - the value for the defaultValue record component
      required - the value for the required record component
      min - the value for the min record component
      max - the value for the max record component
      enumValues - the value for the enumValues 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 '=='.
      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.
      Returns:
      the value of the name record component

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • defaultValue

      public Object defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • min

      public Number min()
      Returns the value of the min record component.
      Returns:
      the value of the min record component

    • max

      public Number max()
      Returns the value of the max record component.
      Returns:
      the value of the max record component

    • enumValues

      public List<String> enumValues()
      Returns the value of the enumValues record component.
      Returns:
      the value of the enumValues record component