Module storm
Package st.orm.template

Record Class SqlTemplate.NamedParameter

java.lang.Object
java.lang.Record
st.orm.template.SqlTemplate.NamedParameter
Record Components:
name - the name of the parameter.
dbValue - the database value of the parameter.
All Implemented Interfaces:
SqlTemplate.Parameter
Enclosing interface:
SqlTemplate
public static record SqlTemplate.NamedParameter(@Nonnull String name, @Nullable Object dbValue) extends Record implements SqlTemplate.Parameter
Represents a named parameter that can be used in a SQL query. The same parameter name can be used multiple times within a single query.

Note: At the SQL template level, the framework enforces that multiple occurrences of the same parameter name must have the same value. This enforcement ensures consistency and prevents logical errors in the query.

  • Constructor Details

    • NamedParameter

      public NamedParameter(@Nonnull String name, @Nullable Object dbValue)
      Creates an instance of a NamedParameter record class.
      Parameters:
      name - the value for the name record component
      dbValue - the value for the dbValue 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.

    • name

      @Nonnull public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • dbValue

      @Nullable public Object dbValue()
      Returns the value of the dbValue record component.
      Specified by:
      dbValue in interface SqlTemplate.Parameter
      Returns:
      the value of the dbValue record component