diff src/main/java/org/monetdb/mcl/net/MapiSocket.java @ 709:bdeabbd46ec6

Resolve javac and javadoc warnings when compiled with JDK19.
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 15 Dec 2022 19:31:53 +0100 (2022-12-15)
parents 940e266eeccd
children aeb268156580
line wrap: on
line diff
--- a/src/main/java/org/monetdb/mcl/net/MapiSocket.java
+++ b/src/main/java/org/monetdb/mcl/net/MapiSocket.java
@@ -432,6 +432,9 @@ public class MapiSocket {	/* cannot (yet
 	 * @param database the database to connect to
 	 * @param hash the hash method(s) to use, or NULL for all supported hashes
 	 * @return the response string for the server
+	 * @throws MCLParseException when parsing failed
+	 * @throws MCLException if an MCL related error occurs
+	 * @throws IOException when IO exception occurred
 	 */
 	private String getChallengeResponse(
 			final String chalstr,
@@ -730,6 +733,11 @@ public class MapiSocket {	/* cannot (yet
 			log.flush();
 	}
 
+	/**
+	 * Set the HandshakeOptions
+	 *
+	 * @param handshakeOptions the options array
+	 */
 	public void setHandshakeOptions(HandshakeOption<?>[] handshakeOptions) {
 		this.handshakeOptions = handshakeOptions;
 	}
@@ -762,6 +770,7 @@ public class MapiSocket {	/* cannot (yet
 		/**
 		 * Constructs this BlockOutputStream, backed by the given
 		 * OutputStream.  A BufferedOutputStream is internally used.
+		 * @param out an OutputStream
 		 */
 		public BlockOutputStream(final OutputStream out) {
 			// always use a buffered stream, even though we know how
@@ -882,6 +891,7 @@ public class MapiSocket {	/* cannot (yet
 		/**
 		 * Constructs this BlockInputStream, backed by the given
 		 * InputStream.  A BufferedInputStream is internally used.
+		 * @param in an InputStream
 		 */
 		public BlockInputStream(final InputStream in) {
 			// always use a buffered stream, even though we know how
@@ -926,7 +936,10 @@ public class MapiSocket {	/* cannot (yet
 		 * our blocks.  Maybe it does speed up on slower links, then
 		 * consider this method a quick bug fix/workaround.
 		 *
+		 * @param b a byte array to store read bytes
+		 * @param len number of bytes to read
 		 * @return false if reading the block failed due to EOF
+		 * @throws IOException if an IO error occurs while reading
 		 */
 		private boolean _read(final byte[] b, int len) throws IOException {
 			int s;
@@ -978,6 +991,9 @@ public class MapiSocket {	/* cannot (yet
 		 *
 		 * If the stream is not positioned correctly, hell will break
 		 * loose.
+		 *
+		 * @return blockLen
+		 * @throws IOException if an IO error occurs while reading
 		 */
 		private int readBlock() throws IOException {
 			// read next two bytes (short)
@@ -1102,6 +1118,7 @@ public class MapiSocket {	/* cannot (yet
 
 		/**
 		 * For internal use
+		 * @return new Raw object
 		 */
 		Raw getRaw() {
 			return new Raw();
@@ -1253,7 +1270,10 @@ public class MapiSocket {	/* cannot (yet
 		private byte[] promptBuffer;
 		private Runnable cancellationCallback = null;
 
-		/** Create an UploadStream with the given chunk size */
+		/**
+		 * Create an UploadStream with the given chunk size
+		 * @param chunkSize chunk size for the upload stream
+		 */
 		UploadStream(final int chunkSize) {
 			super(toMonet);
 			if (chunkSize <= 0) {