Module litebridge.db.spi
Package org.litebridgedb.db.spi.sql

Record Class PreparedSql

java.lang.Object
java.lang.Record
org.litebridgedb.db.spi.sql.PreparedSql
Record Components:
sql - The SQL query string that may contain placeholders for parameterized values.
bindValues - The list of bind values corresponding to the placeholders in the SQL query. Each value can be nullable, represented by the BindValue type.
public record PreparedSql(String sql, List<@Nullable BindValue> bindValues) extends Record
A prepared SQL statement along with its associated bind values.

This record encapsulates the SQL query string and the list of values to be bound to the query parameters.

Instances of this record are immutable and can be used to safely pass SQL queries and their bindings within the application.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PreparedSql(String sql)
    Constructs a new instance of PreparedSql with the provided SQL query string and an empty list of bind values.
    PreparedSql(String sql, List<@Nullable BindValue> bindValues)
    Creates an instance of a PreparedSql record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<@Nullable BindValue>
    bindValues()
    Returns the value of the bindValues 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.
    String
    sql()
    Returns the value of the sql record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PreparedSql

      public PreparedSql(String sql)
      Constructs a new instance of PreparedSql with the provided SQL query string and an empty list of bind values.
      Parameters:
      sql - The SQL query string.

    • PreparedSql

      public PreparedSql(String sql, List<@Nullable BindValue> bindValues)
      Creates an instance of a PreparedSql record class.
      Parameters:
      sql - the value for the sql record component
      bindValues - the value for the bindValues 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • sql

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

    • bindValues

      public List<@Nullable BindValue> bindValues()
      Returns the value of the bindValues record component.
      Returns:
      the value of the bindValues record component