[doc] Add missing Javadoc

Author: adamretter

exist-core/src/main/java/org/exist/dom/persistent/DocumentImpl.java

@@ -504,6 +504,8 @@ public String getMimeType() {
     /**
      * Set the Internet Media Type of the document.
      *
+     * @param mimeType the mime type.
+     *
      * @deprecated Use {@link #setMediaType(String)} instead.
      */
     @Deprecated
@@ -522,6 +524,8 @@ public String getMediaType() {
 
     /**
      * Set the Internet Media Type of the document.
+     *
+     * @param mediaType the Internet Media Type.
      */
     public void setMediaType(final String mediaType) {
         this.mediaType = mediaType;

exist-core/src/main/java/org/exist/storage/io/VariableByteInput.java

@@ -65,44 +65,61 @@ public interface VariableByteInput {
      * Read a single byte and return as an int value.
      * 
      * @return the byte value as int or -1 if no more bytes are available.
-     * @throws IOException in case of an I/O error
+     *
+     * @throws IOException in case of an I/O error.
      */
     int read() throws IOException;
 
     /**
      * Fill the provided byte array with data from the input.
      * 
-     * @param data the buffer to read
+     * @param data the buffer to write data to.
+     *
+     * @return the number of bytes written to the buffer.
+     *
      * @throws IOException in case of an I/O error
-     * @return the number of bytes read
      */
     int read(byte[] data) throws IOException;
-    
-    int read(byte b[], int off, int len) throws IOException;
+
+    /**
+     * Fill the provided byte array with data from the input.
+     *
+     * @param data the buffer to write data to.
+     * @param off the offset in the buffer to start writing at.
+     * @param len the maximum number of bytes to write into the buffer.
+     *
+     * @return the number of bytes written to the buffer.
+     *
+     * @throws IOException in case of an I/O error.
+     */
+    int read(byte data[], int off, int len) throws IOException;
 
     /**
      * Returns a value > 0 if more bytes can be read
      * from the input.
      *
-     * @throws IOException in case of an I/O error
-     * @return the number of bytes available
+     * @return the number of bytes available.
+     *
+     * @throws IOException in case of an I/O error.
      */
     int available() throws IOException;
 
     /**
      * Read a single byte. Throws EOFException if no
      * more bytes are available.
      *
-     * @throws IOException in case of an I/O error
-     * @return the byte read
+     * @return the byte read.
+     *
+     * @throws IOException in case of an I/O error.
      */
     byte readByte() throws IOException;
 
     /**
      * Read a short value in variable byte encoding.
      *
-     * @throws IOException in case of an I/O error
-     * @return the short read
+     * @return the short read.
+     *
+     * @throws IOException in case of an I/O error.
      */
     short readShort() throws IOException;
 
@@ -112,14 +129,17 @@ public interface VariableByteInput {
      * Requires 2 bytes.
      *
      * @return the short.
+     *
+     * @throws IOException in case of an I/O error.
      */
     short readFixedShort() throws IOException;
 
     /**
      * Read an integer value in variable byte encoding.
      *
-     * @throws IOException in case of an I/O error
-     * @return the int read
+     * @return the int read.
+     *
+     * @throws IOException in case of an I/O error.
      */
     int readInt() throws IOException;
 
@@ -129,14 +149,17 @@ public interface VariableByteInput {
      * Requires 4 bytes.
      *
      * @return the int.
+     *
+     * @throws IOException in case of an I/O error.
      */
     int readFixedInt() throws IOException;
 
     /**
      * Read a long value in variable byte encoding.
      *
-     * @throws IOException in case of an I/O error
-     * @return the long read
+     * @return the long read.
+     *
+     * @throws IOException in case of an I/O error.
      */
     long readLong() throws IOException;
 
@@ -146,83 +169,104 @@ public interface VariableByteInput {
      * Requires 8 bytes.
      *
      * @return the long.
+     *
+     * @throws IOException in case of an I/O error.
      */
     long readFixedLong() throws IOException;
 
     /**
      * Read a big integer in variable byte encoding.
      *
-     * @throws IOException in case of an I/O error
+     * @return the big integer read.
      *
-     * @return the big integer read
+     * @throws IOException in case of an I/O error.
      */
     BigInteger readBigInteger() throws IOException;
 
     /**
      * Read a fixed size big integer from input.
      *
-     * @throws IOException in case of an I/O error
+     * @return the big integer read.
      *
-     * @return the big integer read
+     * @throws IOException in case of an I/O error.
      */
     BigInteger readFixedBigInteger() throws IOException;
 
     /**
      * Read a big decimal in variable byte encoding.
      *
-     * @throws IOException in case of an I/O error
+     * @return the big decimal read.
      *
-     * @return the big decimal read
+     * @throws IOException in case of an I/O error.
      */
     BigDecimal readBigDecimal() throws IOException;
 
     /**
      * Read a fixed size big decimal from input.
      *
-     * @throws IOException in case of an I/O error
+     * @return the big decimal read.
      *
-     * @return the big decimal read
+     * @throws IOException in case of an I/O error.
      */
     BigDecimal readFixedBigDecimal() throws IOException;
 
     /**
      * Read a string as UTF-8 encoded bytes from the input.
      *
      * @return the string.
+     *
+     * @throws IOException in case of an I/O error.
      */
     String readUTF() throws IOException;
 
     /**
-     * Read the following count numeric values from the input
-     * and drop them.
+     * Skip over a number of numeric values from.
      * 
-     * @param count the number of bytes to skip
-     * @throws IOException in case of an I/O error
+     * @param count the number of numeric values to skip.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void skip(int count) throws IOException;
 
+    /**
+     * Skip over a number of bytes.
+     *
+     * @param count the number of bytes to skip.
+     *
+     * @throws IOException in case of an I/O error.
+     */
     void skipBytes(long count) throws IOException;
 
     /**
      * Copy the next numeric value from the input to the
      * specified output stream.
      * 
-     * @param output the output destination to copy the data to
-     * @throws IOException in case of an I/O error
+     * @param output the output destination to copy the data to.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void copyTo(VariableByteOutput output) throws IOException;
 
     /**
      * Copy the count next numeric values from the input to
      * the specified output stream.
      * 
-     * @param os the output destination to copy the data to
-     * @param count the number of bytes to copy
-     * @throws IOException in case of an I/O error
+     * @param os the output destination to copy the data to.
+     * @param count the number of bytes to copy.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void copyTo(VariableByteOutput os, int count)
             throws IOException;
-    
+
+    /**
+     * Copy bytes from the input to the specified output stream.
+     *
+     * @param os the output destination to copy the data to.
+     * @param bytes the number of bytes to copy.
+     *
+     * @throws IOException in case of an I/O error.
+     */
     void copyRaw(VariableByteOutput os, int bytes)
     	throws IOException;
 }

exist-core/src/main/java/org/exist/storage/io/VariableByteOutput.java

@@ -35,20 +35,26 @@ public interface VariableByteOutput {
      * Write a byte to the output.
      *
      * @param b the byte to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void write(final int b) throws IOException;
 
     /**
      * Write a byte to the output.
      *
      * @param b the byte to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeByte(final byte b) throws IOException;
 
     /**
      * Write bytes to the output.
      *
      * @param buf the bytes to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void write(final byte[] buf) throws IOException;
 
@@ -58,6 +64,8 @@ public interface VariableByteOutput {
      * @param buf the bytes to write.
      * @param off the offset to read the bytes from.
      * @param len the length of bytes to read.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void write(final byte[] buf, final int off, final int len) throws IOException;
 
@@ -72,7 +80,9 @@ public interface VariableByteOutput {
      *  128 and 16383, 2 bytes
      *  16384 and {@link Short#MAX_VALUE}, 3 bytes
      *
-     *  @param s the short to write.
+     * @param s the short to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeShort(int s) throws IOException;
 
@@ -82,6 +92,8 @@ public interface VariableByteOutput {
      * Requires 2 bytes.
      *
      * @param s the short to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeFixedShort(final short s) throws IOException;
 
@@ -98,7 +110,9 @@ public interface VariableByteOutput {
      *  2097152 and 268435455, is 4 bytes
      *  268435456 and {@link Integer#MAX_VALUE}, 5 bytes
      *
-     *  @param i the integer to write.
+     * @param i the integer to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeInt(int i) throws IOException;
 
@@ -108,6 +122,8 @@ public interface VariableByteOutput {
      * Requires 4 bytes.
      *
      * @param i the integer to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeFixedInt(final int i) throws IOException;
 
@@ -130,6 +146,8 @@ public interface VariableByteOutput {
      *  9223372036854775808 and {@link Long#MAX_VALUE}, 10 bytes
      *
      * @param l the long to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeLong(long l) throws IOException;
 
@@ -139,6 +157,8 @@ public interface VariableByteOutput {
      * Requires 8 bytes.
      *
      * @param l the long to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeFixedLong(final long l) throws IOException;
 
@@ -149,7 +169,9 @@ public interface VariableByteOutput {
      *  VBE int - data length
      *  byte[] - data
      *
-     * @param bi the big integer to write
+     * @param bi the big integer to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeBigInteger(final BigInteger bi) throws IOException;
 
@@ -160,7 +182,9 @@ public interface VariableByteOutput {
      *  int - data length
      *  byte[] - data
      *
-     * @param bi the big integer to write
+     * @param bi the big integer to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeFixedBigInteger(final BigInteger bi) throws IOException;
 
@@ -174,6 +198,8 @@ public interface VariableByteOutput {
      *  byte[] - data
      *
      * @param bd the big decimal to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeBigDecimal(final BigDecimal bd) throws IOException;
 
@@ -187,13 +213,17 @@ public interface VariableByteOutput {
      *  byte[] - data
      *
      * @param bd the big decimal to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeFixedBigDecimal(final BigDecimal bd) throws IOException;
 
     /**
      * Write a string as UTF-8 encoded bytes to the output.
      *
      * @param s the string to write.
+     *
+     * @throws IOException in case of an I/O error.
      */
     void writeUTF(final String s) throws IOException;
 }