changeset 708:5022a57f9d97

Resolve javadoc errors.
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 15 Dec 2022 15:45:32 +0100 (2022-12-15)
parents 7752e15b6a23
children bdeabbd46ec6
files src/main/java/org/monetdb/jdbc/MonetCallableStatement.java src/main/java/org/monetdb/jdbc/MonetConnection.java src/main/java/org/monetdb/jdbc/MonetDriver.java.in src/main/java/org/monetdb/jdbc/MonetPreparedStatement.java src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
diffstat 5 files changed, 11 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/src/main/java/org/monetdb/jdbc/MonetCallableStatement.java
+++ b/src/main/java/org/monetdb/jdbc/MonetCallableStatement.java
@@ -105,7 +105,7 @@ public final class MonetCallableStatemen
 	}
 
 	/** parse call query string on
-	 *  { [?=] call <procedure-name> [(<arg1>,<arg2>, ...)] }
+	 *  { [?=] call &lt;procedure-name&gt; [(&lt;arg1&gt;,&lt;arg2&gt;, ...)] }
 	 * and remove the JDBC escapes pairs: { and }
 	 */
 	final private static String removeEscapes(final String query) {
--- a/src/main/java/org/monetdb/jdbc/MonetConnection.java
+++ b/src/main/java/org/monetdb/jdbc/MonetConnection.java
@@ -2052,7 +2052,7 @@ public class MonetConnection
 
 
 	/**
-	 * Internal utility method to query the server to find out if it has a specific system table sys.<tablename>.
+	 * Internal utility method to query the server to find out if it has a specific system tables.
 	 */
 	private void querySysTable() {
 		Statement stmt = null;
@@ -2267,7 +2267,7 @@ public class MonetConnection
 	 * % 60 0,	32 0 # typesizes
 	 * </pre>
 	 * there the first line consists out of<br />
-	 * <tt>&amp;"qt" "id" "tc" "cc" "rc"</tt>.
+	 * <samp>&amp;"qt" "id" "tc" "cc" "rc"</samp>.
 	 */
 	// {{{ ResultSetResponse class implementation
 	final class ResultSetResponse implements Response {
@@ -2905,7 +2905,7 @@ public class MonetConnection
 	 * response keeps a count field that represents the affected rows
 	 * and a field that contains the last inserted auto-generated ID, or
 	 * -1 if not applicable.<br />
-	 * <tt>&amp;2 0 -1</tt>
+	 * <samp>&amp;2 0 -1</samp>
 	 */
 	// {{{ UpdateResponse class implementation
 	final static class UpdateResponse implements Response {
@@ -2949,7 +2949,7 @@ public class MonetConnection
 	 * defined by JDBC, which is currently in MonetDB's case alwats
 	 * SUCCESS_NO_INFO.  Note that this state is not sent by the
 	 * server.<br />
-	 * <tt>&amp;3</tt>
+	 * <samp>&amp;3</samp>
 	 */
 	// {{{ SchemaResponse class implementation
 	class SchemaResponse implements Response {
@@ -2982,7 +2982,7 @@ public class MonetConnection
 	/**
 	 * The AutoCommitResponse represents a transaction message.  It
 	 * stores (a change in) the server side auto commit mode.<br />
-	 * <tt>&amp;4 (t|f)</tt>
+	 * <samp>&amp;4 (t|f)</samp>
 	 */
 	// {{{ AutoCommitResponse class implementation
 	private final class AutoCommitResponse extends SchemaResponse {
--- a/src/main/java/org/monetdb/jdbc/MonetDriver.java.in
+++ b/src/main/java/org/monetdb/jdbc/MonetDriver.java.in
@@ -383,6 +383,7 @@ public class MonetDriver implements Driv
 		return Types.OTHER;
 	}
 
+	private static String TypeMapppingSQL;	// cache to optimise getSQLTypeMap()
 	/**
 	 * Returns a String usable in an SQL statement to map the server types
 	 * to values of java.sql.Types using the global static type map.
@@ -393,7 +394,6 @@ public class MonetDriver implements Driv
 	 *               in the SQL CASE statement
 	 * @return a SQL CASE statement
 	 */
-	private static String TypeMapppingSQL;	// cache to optimise getSQLTypeMap()
 	static final String getSQLTypeMap(final String column) {
 		if (TypeMapppingSQL == null) {
 			// first time, compose TypeMappping SQL string
--- a/src/main/java/org/monetdb/jdbc/MonetPreparedStatement.java
+++ b/src/main/java/org/monetdb/jdbc/MonetPreparedStatement.java
@@ -2917,6 +2917,7 @@ public class MonetPreparedStatement
 			paramValues[parameterIndex] = "NULL";
 	}
 
+	private StringBuilder execStmt;	// created once, re-used multiple times so much less objects are created and gc-ed
 	/**
 	 * Constructs an "exec ##(paramval, ...)" statement string for the current parameter values.
 	 * Mind that the JDBC specs allow 'reuse' of a value for a parameter over multiple executes.
@@ -2924,7 +2925,6 @@ public class MonetPreparedStatement
 	 * @return the "exec ##(...)" string
 	 * @throws SQLException if not all parameters are set with a value
 	 */
-	private StringBuilder execStmt;	// created once, re-used multiple times so much less objects are created and gc-ed
 	private final String transform() throws SQLException {
 		if (execStmt == null)
 			// first time use, create it once
--- a/src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
+++ b/src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
@@ -22,9 +22,9 @@ import java.io.UnsupportedEncodingExcept
  * to get its {@link LineType} and {@link #advance()} to proceed to the
  * next line.
  *
- * Initially, the line type is set to {@link LineType.UNKNOWN} and the line
+ * Initially, the line type is set to LineType.UNKNOWN and the line
  * is set to null. When the end of the result set has been reached the line type
- * will remain {@link LineType.PROMPT} and the line will again be null.
+ * will remain LineType.PROMPT and the line will again be null.
  *
  * To start reading the next response, call {@link #resetLineType()}. This
  * is usually done automatically by the accompanying {@link BufferedMCLWriter}
@@ -140,7 +140,7 @@ public final class BufferedMCLReader {
 	/**
 	 * Discard the remainder of the response but collect any further error messages.
 	 *
-	 * @param error A StringBuilder containing earlier error messages to include in the error report.
+	 * @param errmsgs An optional StringBuilder object containing earlier error messages to include in the error report.
 	 * @return a string containing error messages, or null if there aren't any
 	 * @throws IOException if an IO exception occurs while talking to the server
 	 *