changeset 640:0f5d924751e7

Add comments for LineType '=' and correct the return type information for javadoc.
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 27 Jan 2022 20:39:10 +0100 (2022-01-27)
parents 899f0c120256
children fac0ed642af2
files src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java src/main/java/org/monetdb/mcl/io/LineType.java
diffstat 2 files changed, 6 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
+++ b/src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java
@@ -108,9 +108,9 @@ public final class BufferedMCLReader ext
 	/**
 	 * getLineType returns the type of the last line read.
 	 *
-	 * @return an integer representing the kind of line this is, one of the
-	 *         following constants: UNKNOWN, HEADER, ERROR, PROMPT, MORE,
-	 *         RESULT, SOHEADER, REDIRECT, INFO
+	 * @return Linetype representing the kind of line this is, one of the
+	 *         following enums: UNKNOWN, HEADER, ERROR, RESULT,
+	 *         PROMPT, MORE, FILETRANSFER, SOHEADER, REDIRECT, INFO
 	 */
 	public LineType getLineType() {
 		return lineType;
--- a/src/main/java/org/monetdb/mcl/io/LineType.java
+++ b/src/main/java/org/monetdb/mcl/io/LineType.java
@@ -21,7 +21,7 @@ public enum LineType {
 	/** a line starting with % indicates HEADER */
 	HEADER(new byte[] { '%' }),
 
-	/** a line starting with [ indicates RESULT */
+	/** a line starting with [ or = indicates RESULT */
 	RESULT(new byte[] { '[' }),
 
 	/** a line which matches the pattern of prompt1 is a PROMPT */
@@ -92,8 +92,8 @@ public enum LineType {
 				return ERROR;
 			case '%':
 				return HEADER;
-			case '[':
-			case '=':
+			case '[':	// tuple result
+			case '=':	// single value result or result of PLAN/EXPLAIN/TRACE queries
 				return RESULT;
 			case '&':
 				return SOHEADER;