Skip to content

Commit 0a943a6

Browse files
committed
Fix for javadoc.
1 parent c6dbf00 commit 0a943a6

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

src/main/protocol-impl/java/com/mysql/cj/protocol/x/CompressionSplittedInputStream.java

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,9 @@ private Compression parseCompressedMessage() {
246246
*
247247
* @return
248248
* <code>true</code> if this frame's bytes weren't all consumed yet, <code>false</code> otherwise.
249+
*
250+
* @throws IOException
251+
* if any of the underlying I/O operations fail.
249252
*/
250253
private boolean isDataAvailable() throws IOException {
251254
return isCompressedDataAvailable() || this.frameHeaderConsumed > 0 && this.frameHeaderConsumed < HEADER_LENGTH
@@ -257,6 +260,9 @@ private boolean isDataAvailable() throws IOException {
257260
*
258261
* @return
259262
* <code>true</code> if there is compressed data available, <code>false</code> otherwise.
263+
*
264+
* @throws IOException
265+
* if any of the underlying I/O operations fail.
260266
*/
261267
private boolean isCompressedDataAvailable() throws IOException {
262268
return this.compressorIn != null && this.compressorIn.available() > 0;
@@ -267,6 +273,9 @@ private boolean isCompressedDataAvailable() throws IOException {
267273
*
268274
* @return
269275
* <code>true</code> if all compressed data was consumed, <code>false</code> otherwise.
276+
*
277+
* @throws IOException
278+
* if any of the underlying I/O operations fail.
270279
*/
271280
private boolean isCompressedDataReadComplete() throws IOException {
272281
return this.compressorIn != null && this.compressorIn.available() == 0;
@@ -315,15 +324,18 @@ private final int readFully(byte[] b, int off, int len) throws IOException {
315324
/**
316325
* Reads the exact number of requested bytes from the given {@link InputStream}, blocking if needed.
317326
*
327+
* @param inStream
328+
* input stream to read from
318329
* @param b
319330
* the buffer into which the data is read.
320331
* @param off
321332
* the start offset in the destination array <code>b</code>
322333
* @param len
323334
* the maximum number of bytes read.
324335
* @return the total number of bytes read into the buffer, or <code>-1</code> if there is no more data because the end of the stream has been reached.
325-
* @exception IOException
326-
* if any of the underlying I/O operations fail.
336+
*
337+
* @throws IOException
338+
* if any of the underlying I/O operations fail.
327339
*/
328340
private final int readFully(InputStream inStream, byte[] b, int off, int len) throws IOException {
329341
if (len < 0) {

src/main/user-api/java/com/mysql/cj/xdevapi/Schema.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,15 +254,19 @@ public Validation getValidation() {
254254
* {@link Schema#modifyCollection(String, ModifyCollectionOptions)}.
255255
* <p>
256256
* Allowed options are:
257+
* <ul>
257258
* <li>schema - JSON schema as a String
258259
* <li>level - {@link ValidationLevel}
260+
* </ul>
259261
*/
260262
public static class Validation {
261263

262264
/**
263265
* Defines how validation options are applied.
266+
* <ul>
264267
* <li>STRICT - enable JSON schema validation for documents in the collection.
265268
* <li>OFF - disable JSON schema validation.
269+
* </ul>
266270
*/
267271
public static enum ValidationLevel {
268272
STRICT, OFF

0 commit comments

Comments
 (0)