Add some documentation

lucidsoftware · Sep 26, 2023 · ad9553d · ad9553d
1 parent 57ac2ff
commit ad9553d
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/relate/src/main/scala/com/lucidchart/relate/Parameterizable.scala b/relate/src/main/scala/com/lucidchart/relate/Parameterizable.scala
@@ -8,13 +8,27 @@ import java.util.UUID
 
 trait Parameterizable[-A] {
   final def contraMap[B](f: B => A) = Parameterizable((statement, i, value: B) => set(statement, i, f(value)), setNull)
+  /**
+   * Set the parameterized value at index {@code i} in the prepared  statement to the {@code value}.
+   */
   def set(statement: PreparedStatement, i: Int, value: A)
+  /**
+   * Set the parameterized value at index {@code i} in the prepared  statement to {@code null}.
+   */
   def setNull(statement: PreparedStatement, i: Int)
   final def setOption(statement: PreparedStatement, i: Int, value: Option[A]) =
     value.fold(setNull(statement, i))(set(statement, i, _))
 }
 
 object Parameterizable {
+  /**
+   * Create new Parameterizable instance from functions for set and setNull
+   *
+   * @param f
+   *   The function to implement [[Parameterizable#set]] with
+   * @param g
+   *   The function to implement [[Parameterizable#setNull]] with
+   */
   def apply[A](f: (PreparedStatement, Int, A) => Unit, g: (PreparedStatement, Int) => Unit) = new Parameterizable [A] {
     def set(statement: PreparedStatement, i: Int, value: A) = f(statement, i, value)
     def setNull(statement: PreparedStatement, i: Int) = g(statement, i)
@@ -25,7 +39,7 @@ object Parameterizable {
   implicit val array = apply(_.setArray(_, _: Array), _.setNull(_, Types.ARRAY))
   // ideally, this would be named jBigDecimal, but that wouldn't be  backwards compatibility
   implicit val bigDecimal = apply(_.setBigDecimal(_, _: java.math.BigDecimal), _.setNull(_, Types.DECIMAL))
-  implicit val scalaBigDecimal = apply[scala.math.BigDecimal](_.setBigDecimal(_, _.bigDecimal), _.setNull(_, Types.DECIMAL))
+  implicit val scalaBigDecimal = apply((stmt: PreparedStatement, i: Int, v: scala.math.BigDecimal) => stmt.setBigDecimal(i, v.bigDecimal), _.setNull(_, Types.DECIMAL))
   implicit val blob = apply(_.setBlob(_, _: Blob), _.setNull(_, Types.BLOB))
   implicit val boolean = apply(_.setBoolean(_, _: Boolean), _.setNull(_, Types.BOOLEAN))
   implicit val byte = apply(_.setByte(_, _: Byte), _.setNull(_, Types.TINYINT))