Mercurial > hg > monetdb-java

diff src/main/java/nl/cwi/monetdb/merovingian/Control.java @ 194:1296dbcc4958

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Resolved javadoc many errors and warnings, such as: [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/HeaderLineParser.java:17: error: malformed HTML [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/HeaderLineParser.java:17: error: bad use of '>' [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/StartOfHeaderParser.java:23: error: malformed HTML [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/StartOfHeaderParser.java:23: error: bad use of '>' [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java:37: error: reference not found [javadoc] * @throws ParseException if an error occurs during parsing [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java:16: error: malformed HTML [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java:16: error: bad use of '>' [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java:40: error: malformed HTML [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java:40: error: bad use of '>' [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java:84: warning: no @throws for java.io.UnsupportedEncodingException [javadoc] public BufferedMCLReader(InputStream in, String enc) [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java:35: error: malformed HTML [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java:35: error: bad use of '>' [javadoc] * @author Fabian Groffen <Fabian.Groffen> [javadoc] ^ [javadoc] /export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java:59: warning: no @throws for java.io.UnsupportedEncodingException [javadoc] public BufferedMCLWriter(OutputStream in, String enc) [javadoc] ^
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 26 Oct 2017 17:40:05 +0200 (2017-10-26)
parents b9b35ca2eec2
children 89c285fc0a49 c38d4eaf5479
line wrap: on
line diff
--- a/src/main/java/nl/cwi/monetdb/merovingian/Control.java
+++ b/src/main/java/nl/cwi/monetdb/merovingian/Control.java
@@ -31,7 +31,7 @@ import java.util.Properties;
  * This class implements the protocol specific bits to perform all
  * possible actions against a merovingian server that has remote control
  * facilities enabled.
- * <br />
+ *
  * In the merovingian world, other merovingians in the vicinity are
  * known to each merovingian, allowing to perform cluster wide actions.
  * The implementation taken in this class is to require one known
@@ -56,6 +56,9 @@ public class Control {
 	/**
 	 * Constructs a new Control object.
 	 *
+	 * @param host - IP address or DNS
+	 * @param port - port number
+	 * @param passphrase - phrase used to pass authorisation
 	 * @throws IllegalArgumentException if host, port or passphrase are
 	 * null or &lt;= 0
 	 */
@@ -343,10 +346,12 @@ public class Control {
 	/**
 	 * Test whether a specific database exists. 
 	 * 
-	 * @param database
+	 * @param database name of database
 	 * @return true, iff database already exists.
-	 * @throws MerovingianException
-	 * @throws IOException
+	 * @throws MerovingianException if performing the command failed at
+	 *         the merovingian side
+	 * @throws IOException if connecting to or communicating with
+	 *         merovingian failed
 	 */
 	public boolean exists(String database)
 		throws MerovingianException, IOException