#67: Mark 'ResultSetParser::csvLine' method as deprecated.

The method has been renamed to 'ResultSetParser::csv'.

Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>

Author: jenetics

facilejdbc/src/main/java/io/jenetics/facilejdbc/Param.java

@@ -42,6 +42,15 @@
  * );
  * }
  * <p>
+ * <b>Creating (lazy) single-valued parameters</b>
+ * {@snippet lang="java":
+ * INSERT_QUERY.on(
+ *     Param.lazyValue("inserted_at", Instant::now),
+ *     Param.value("forename", "Werner"),
+ *     Param.value("email", "some.email@gmail.com")
+ * );
+ * }
+ * <p>
  * <b>Creating multi-valued parameters</b>
  * {@snippet lang="java":
  * var query = Query.of("SELECT * FROM table WHERE id = IN(:ids);")

facilejdbc/src/main/java/io/jenetics/facilejdbc/ResultSetParser.java

@@ -68,11 +68,37 @@ T parse(final ResultSet rs, final Connection conn)
 	/**
 	 * Return a {@link ResultSet} parser, which converts the query result to a
 	 * CSV line.
-	 * {@snippet lang="java":
+	 * {@snippet lang = "java":
+	 * final var select = Query.of("SELECT * FROM book;");
+	 * final var csv = select.as(ResultSetParser.csv(), conn);
+	 * System.out.println(csv);
+	 *}
+	 * The CSV output will look like this:
+	 * <pre>
+	 * "ID","PUBLISHED_AT","TITLE","ISBN","PAGES"
+	 * "0","1987-02-04","Auf der Suche nach der verlorenen Zeit","978-3518061756","5100"
+	 * "1","1945-01-04","Database Design for Mere Mortals","978-0321884497","654"
+	 * "2","1887-02-04","Der alte Mann und das Meer","B00JM4RD2S","142"
+	 * </pre>
+	 *
+	 * @since 3.0
+	 *
+	 * @see RowParser#csvLine()
+	 *
+	 * @return a CSV {@link ResultSet} parser
+	 */
+	static ResultSetParser<String> csv() {
+		return CSV::string;
+	}
+
+	/**
+	 * Return a {@link ResultSet} parser, which converts the query result to a
+	 * CSV line.
+	 * {@snippet lang = "java":
 	 * final var select = Query.of("SELECT * FROM book;");
 	 * final var csv = select.as(ResultSetParser.csvLine(), conn);
 	 * System.out.println(csv);
-	 * }
+	 *}
 	 * The CSV output will look like this:
 	 * <pre>
 	 * "ID","PUBLISHED_AT","TITLE","ISBN","PAGES"
@@ -87,6 +113,7 @@ T parse(final ResultSet rs, final Connection conn)
 	 *
 	 * @return a CSV {@link ResultSet} parser
 	 */
+	@Deprecated(since = "3.0", forRemoval = true)
 	static ResultSetParser<String> csvLine() {
 		return CSV::string;
 	}

facilejdbc/src/main/java/io/jenetics/facilejdbc/RowParser.java

@@ -841,7 +841,7 @@ static RowParser<LocalDate> date(final int index) {
 	 *
 	 * @since 1.3
 	 *
-	 * @see ResultSetParser#csvLine()
+	 * @see ResultSetParser#csv()
 	 * @see #ofColumns(Function)
 	 *
 	 * @return a row parser which converts a DB row into a CSV row

facilejdbc/src/test/java/io/jenetics/facilejdbc/ParamsTest.java

@@ -20,6 +20,7 @@
 package io.jenetics.facilejdbc;
 
 import java.sql.SQLException;
+import java.time.Instant;
 import java.util.List;
 
 import org.testng.Assert;
@@ -39,7 +40,8 @@ public void set() throws SQLException {
 			Param.value("name_2", "value_2"),
 			Param.value("name_3", "value_3"),
 			Param.value("name_4", "value_4"),
-			Param.value("name_5", "value_5")
+			Param.value("name_5", "value_5"),
+			Param.lazyValue("inserted_at", Instant::now)
 		));
 
 		params.set(List.of("name_2", "name_5", "name_1"), stmt);

facilejdbc/src/test/java/io/jenetics/facilejdbc/testdb/TestDbTest.java

@@ -221,7 +221,7 @@ public void selectEmptyStream() throws SQLException {
 	public void selectToCSV() throws SQLException {
 		db.transaction().accept(conn -> {
 			final var select = Query.of("SELECT * FROM book ORDER BY id;");
-			final var csv = select.as(ResultSetParser.csvLine(), conn);
+			final var csv = select.as(ResultSetParser.csv(), conn);
 
 			final var expected = """
 				"ID","PUBLISHED_AT","TITLE","LANGUAGE","ISBN","PAGES"