Mercurial > hg > monetdb-java

annotate src/main/java/org/monetdb/mcl/io/BufferedMCLReader.java @ 706:21fd1eebbd0e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some more Javadoc improvements.
author Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
date Fri, 09 Dec 2022 13:09:28 +0100 (2022-12-09)
parents b4e968e5bd74
children 5022a57f9d97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
1 /*
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
2 * This Source Code Form is subject to the terms of the Mozilla Public
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
5 *
610
6aa38e8c0f2d Updated Copyright year.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 553
diff changeset
6 * Copyright 1997 - July 2008 CWI, August 2008 - 2022 MonetDB B.V.
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
7 */
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
8
391
f523727db392 Moved Java classes from packages starting with nl.cwi.monetdb.* to package org.monetdb.*
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 350
diff changeset
9 package org.monetdb.mcl.io;
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
10
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
11 import java.io.BufferedReader;
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
12 import java.io.IOException;
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
13 import java.io.InputStream;
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
14 import java.io.Reader;
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
15 import java.io.UnsupportedEncodingException;
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
16
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
17 /**
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
18 * Helper class to read and classify the lines of a query response.
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
19 *
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
20 * This class wraps and buffers the Reader on which the responses come in.
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
21 * Use {@link #getLine()} to get the current line, {@link #getLineType()}
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
22 * to get its {@link LineType} and {@link #advance()} to proceed to the
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
23 * next line.
180
fdf4c888d5b7 Small code and layout improvements
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 90
diff changeset
24 *
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
25 * Initially, the line type is set to {@link LineType.UNKNOWN} and the line
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
26 * is set to null. When the end of the result set has been reached the line type
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
27 * will remain {@link LineType.PROMPT} and the line will again be null.
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
28 *
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
29 * To start reading the next response, call {@link #resetLineType()}. This
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
30 * is usually done automatically by the accompanying {@link BufferedMCLWriter}
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
31 * whenever a new request is sent to the server.
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
32 *
194
1296dbcc4958 Resolved javadoc many errors and warnings, such as:
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 180
diff changeset
33 * @author Fabian Groffen
391
f523727db392 Moved Java classes from packages starting with nl.cwi.monetdb.* to package org.monetdb.*
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 350
diff changeset
34 * @see org.monetdb.mcl.net.MapiSocket
f523727db392 Moved Java classes from packages starting with nl.cwi.monetdb.* to package org.monetdb.*
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 350
diff changeset
35 * @see org.monetdb.mcl.io.BufferedMCLWriter
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
36 */
702
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
37 public final class BufferedMCLReader {
180
fdf4c888d5b7 Small code and layout improvements
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 90
diff changeset
38
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
39 private final BufferedReader inner;
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
40 private String current = null;
553
50b15ee1cb5e Process suggestions from Martin
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 542
diff changeset
41 private LineType lineType = LineType.UNKNOWN;
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
42
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
43 /**
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
44 * Create a buffering character-input stream that uses a
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
45 * default-sized input buffer.
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
46 *
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
47 * @param in A Reader
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
48 */
297
bb273e9c7e09 Add "final" keyword to classes, method arguments and local variables where possible.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 280
diff changeset
49 public BufferedMCLReader(final Reader in) {
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
50 inner = new BufferedReader(in);
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
51 }
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
52
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
53 /**
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
54 * Create a buffering character-input stream that uses a
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
55 * default-sized input buffer, from an InputStream.
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
56 *
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
57 * @param in An InputStream
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
58 * @param enc Encoding
194
1296dbcc4958 Resolved javadoc many errors and warnings, such as:
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 180
diff changeset
59 * @throws UnsupportedEncodingException If encoding is not supported
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
60 */
297
bb273e9c7e09 Add "final" keyword to classes, method arguments and local variables where possible.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 280
diff changeset
61 public BufferedMCLReader(final InputStream in, final String enc)
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
62 throws UnsupportedEncodingException
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
63 {
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
64 this(new java.io.InputStreamReader(in, enc));
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
65 }
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
66
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
67 /**
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
68 * Proceed to the next line of the response.
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
69 *
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
70 * Set line type to PROMPT and line to null if the end of the response
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
71 * has been reached.
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
72 * @throws IOException
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
73 */
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
74 public void advance() throws IOException {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
75 if (lineType == LineType.PROMPT)
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
76 return;
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
77
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
78 current = inner.readLine();
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
79 lineType = LineType.classify(current);
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
80 if (lineType == LineType.ERROR && current != null && !current.matches("^![0-9A-Z]{5}!.+")) {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
81 current = "!22000!" + current.substring(1);
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
82 }
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
83 }
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
84
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
85 /**
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
86 * Reset the linetype to UNKNOWN.
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
87 */
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
88 public void resetLineType() {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
89 lineType = LineType.UNKNOWN;
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
90 }
391
f523727db392 Moved Java classes from packages starting with nl.cwi.monetdb.* to package org.monetdb.*
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 350
diff changeset
91
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
92 /**
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
93 * Return the current line, or null if we're at the end or before the beginning.
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
94 * @return the current line or null
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
95 */
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
96 public String getLine() {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
97 return current;
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
98 }
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
99
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
100 /**
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
101 * getLineType returns the type of the current line.
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
102 *
640
0f5d924751e7 Add comments for LineType '=' and correct the return type information for javadoc.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 610
diff changeset
103 * @return Linetype representing the kind of line this is, one of the
0f5d924751e7 Add comments for LineType '=' and correct the return type information for javadoc.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 610
diff changeset
104 * following enums: UNKNOWN, HEADER, ERROR, RESULT,
0f5d924751e7 Add comments for LineType '=' and correct the return type information for javadoc.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 610
diff changeset
105 * PROMPT, MORE, FILETRANSFER, SOHEADER, REDIRECT, INFO
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
106 */
497
aed7f32e029a Refactor LineType to be an enum
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 406
diff changeset
107 public LineType getLineType() {
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
108 return lineType;
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
109 }
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
110
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
111 /**
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
112 * Discard the remainder of the response but collect any further error messages.
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
113 *
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
114 * @return a string containing error messages, or null if there aren't any
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
115 * @throws IOException if an IO exception occurs while talking to the server
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
116 */
702
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
117 final public String discardRemainder() throws IOException {
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
118 return discard(null);
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
119 }
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
120
702
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
121 /**
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
122 * Discard the remainder of the response but collect any further error messages.
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
123 *
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
124 * @param error A string containing earlier error messages to include in the error report.
702
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
125 * @return a string containing error messages, or null if there aren't any
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
126 * @throws IOException if an IO exception occurs while talking to the server
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
127 */
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
128 final public String discardRemainder(String error) throws IOException {
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
129 final StringBuilder sb;
280
72efb3e34436 Improve setLineType()
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 261
diff changeset
130
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
131 if (error != null) {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
132 sb = makeErrorBuffer();
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
133 sb.append(error);
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
134 } else {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
135 sb = null;
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
136 }
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
137 return discard(sb);
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
138 }
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
139
702
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
140 /**
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
141 * Discard the remainder of the response but collect any further error messages.
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
142 *
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
143 * @param error A StringBuilder containing earlier error messages to include in the error report.
702
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
144 * @return a string containing error messages, or null if there aren't any
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
145 * @throws IOException if an IO exception occurs while talking to the server
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
146 *
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
147 * TODO(Wouter): should probably not have to be synchronized.
b4e968e5bd74 Some improvements.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 700
diff changeset
148 */
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
149 final synchronized String discard(StringBuilder errmsgs) throws IOException {
553
50b15ee1cb5e Process suggestions from Martin
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 542
diff changeset
150 while (lineType != LineType.PROMPT) {
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
151 advance();
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
152 if (getLine() == null)
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
153 throw new IOException("Connection to server lost!");
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
154 if (getLineType() == LineType.ERROR) {
654
755c05380872 Optimise waitForPrompt() by delaying the creation of a new StringBuilder object till it is really needed.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 640
diff changeset
155 if (errmsgs == null)
755c05380872 Optimise waitForPrompt() by delaying the creation of a new StringBuilder object till it is really needed.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 640
diff changeset
156 errmsgs = new StringBuilder(128);
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
157 errmsgs.append('\n').append(getLine().substring(1));
654
755c05380872 Optimise waitForPrompt() by delaying the creation of a new StringBuilder object till it is really needed.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 640
diff changeset
158 }
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
159 }
654
755c05380872 Optimise waitForPrompt() by delaying the creation of a new StringBuilder object till it is really needed.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 640
diff changeset
160 if (errmsgs == null)
755c05380872 Optimise waitForPrompt() by delaying the creation of a new StringBuilder object till it is really needed.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 640
diff changeset
161 return null;
655
2ded26c5a679 Revert an unwanted change which causes errors being reported on the testweb.
Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
parents: 654
diff changeset
162 return errmsgs.toString().trim();
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
163 }
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
164
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
165 private final StringBuilder makeErrorBuffer() {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
166 return new StringBuilder(128);
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
167 }
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
168
706
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
169 /**
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
170 * Close the wrapped Reader.
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
171 * @throws IOException
21fd1eebbd0e Some more Javadoc improvements.
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 702
diff changeset
172 */
700
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
173 public void close() throws IOException {
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
174 inner.close();
940e266eeccd Refactor BufferedMCLReader
Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>
parents: 655
diff changeset
175 }
0
a5a898f6886c Copy of MonetDB java directory changeset e6e32756ad31.
Sjoerd Mullender <sjoerd@acm.org>
parents:
diff changeset
176 }