fixup JavaDoc issue for splitters #1246

Author: lling

marklogic-client-api/src/main/java/com/marklogic/client/datamovement/JSONSplitter.java

@@ -96,7 +96,7 @@ public long getCount() {
      * Takes an InputStream of a JSON file and split it into a steam of handles.
      * @param input is the incoming InputStream of a JSON file.
      * @return a stream of handles to write to database
-     * @throws IOException
+     * @throws IOException if the input cannot be split
      */
     @Override
     public Stream<T> split(InputStream input) throws IOException {
@@ -112,7 +112,7 @@ public Stream<T> split(InputStream input) throws IOException {
      * Takes an InputStream of a JSON file and split it into a steam of DocumentWriteOperation to write to database.
      * @param input is the incoming input stream of a JSON file
      * @return a stream of DocumentWriteOperation to write to database
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) throws Exception {
@@ -126,7 +126,7 @@ public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) th
      * @param inputName is the name of input file, including name and extension. It is used to generate URLs for split
      *                  files.The inputName could either be provided here or in user-defined UriMaker.
      * @return a stream of DocumentWriteOperation to write to database
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input, String inputName) throws Exception {
@@ -142,7 +142,7 @@ public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input, St
      * Take an input of JsonParser created from the JSON file and split it into a stream of handles to write to database.
      * @param input JsonParser created from the JSON file
      * @return a stream of handles to write to database
-     * @throws IOException
+     * @throws IOException if the input cannot be split
      */
     public Stream<T> split(JsonParser input) throws IOException {
         if (input == null) {
@@ -229,6 +229,7 @@ public void endArray(String containerKey) {
         /**
          * Construct buffered DocumentWriteOperations from the handle which contains target content
          * @param uriMaker the UriMake to construct the URI for each document
+         * @param count the count of each split
          * @param handle the handle contains target object or array
          * @return DocumentWriteOperations to write to database
          */

marklogic-client-api/src/main/java/com/marklogic/client/datamovement/LineSplitter.java

@@ -69,7 +69,7 @@ public long getCount() {
      * Provide GZIPInputStream to the splitter when splitting gzip files.
      * @param input is the incoming input stream.
      * @return a stream of StringHandle.
-     * @throws IOException
+     * @throws IOException if the input cannot be split
      */
     @Override
     public Stream<StringHandle> split(InputStream input) throws IOException {
@@ -82,7 +82,7 @@ public Stream<StringHandle> split(InputStream input) throws IOException {
      * Provide GZIPInputStream to the splitter when splitting gzip files.
      * @param input is the incoming input stream.
      * @return a stream of DocumentWriteOperation.
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) throws Exception {
@@ -97,7 +97,7 @@ public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) th
      * @param splitFilename is the name of the input file, including name and extension. It is used to generate URLs for
      *                  split files. The inputName could either be provided here or in user-defined UriMaker.
      * @return a stream of DocumentWriteOperation.
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input, String splitFilename) throws Exception {
@@ -143,7 +143,7 @@ public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input, St
      * @param input is the incoming input stream.
      * @param charset is the encoding scheme the document uses.
      * @return a stream of StringHandle.
-     * @throws IOException
+     * @throws IOException if the input cannot be split
      */
     public Stream<StringHandle> split(InputStream input, Charset charset) throws IOException {
         if (input == null) {
@@ -160,7 +160,7 @@ public Stream<StringHandle> split(InputStream input, Charset charset) throws IOE
      * line-delimited JSON file, line-delimited XML file or gzip-compressed line-delimited JSON file.
      * @param input is the incoming Reader.
      * @return a stream of StringHandle.
-     * @throws IOException
+     * @throws IOException if the input cannot be split
      */
     public Stream<StringHandle> split(Reader input) throws IOException {
         if (input == null) {

marklogic-client-api/src/main/java/com/marklogic/client/datamovement/XMLSplitter.java

@@ -97,8 +97,8 @@ public void setVisitor(XMLSplitter.Visitor<T> visitor) {
      * Takes an input stream of an XML file and split it into a steam of handles.
      * @param input is the incoming input stream of an XML file
      * @return a stream of handles to write to database
-     * @throws IOException
-     * @throws XMLStreamException
+     * @throws IOException if the input cannot be split
+     * @throws XMLStreamException if there is an error processing the underlying XML source
      */
     @Override
     public Stream<T> split(InputStream input) throws IOException, XMLStreamException {
@@ -114,7 +114,7 @@ public Stream<T> split(InputStream input) throws IOException, XMLStreamException
      * Takes an input stream of an XML file and split it into a steam of DocumentWriteOperation.
      * @param input is the incoming input stream.
      * @return a stream of DocumentWriteOperation to write to database
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) throws Exception {
@@ -127,7 +127,7 @@ public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) th
      * @param inputName is the name of input file, including name and extension. It is used to generate URLs for split
      *                  files.The inputName could either be provided here or in user-defined UriMaker.
      * @return a stream of DocumentWriteOperation to write to database
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input, String inputName) throws Exception {
@@ -148,7 +148,7 @@ public long getCount() {
      * Take an input of XMLStreamReader of the XML file and split it into a stream of handles to write to database.
      * @param input an XMLStreamReader of the XML file
      * @return a stream of handles to write to database
-     * @throws IOException
+     * @throws IOException if the input cannot be split
      */
     public Stream<T> split(XMLStreamReader input) throws IOException {
 
@@ -242,6 +242,8 @@ public void endElement(String nsUri, String localName) {
 
         /**
          * Construct buffered DocumentWriteOperations from XMLStreamReader
+         * @param uriMaker the UriMake to construct the URI for each document
+         * @param count the count of each split
          * @param handle the handle contains target elements as content
          * @return DocumentWriteOperations to write to database
          */

marklogic-client-api/src/main/java/com/marklogic/client/datamovement/ZipSplitter.java

@@ -159,7 +159,7 @@ public Stream<BytesHandle> split(ZipInputStream input) throws IOException {
      * The ZIP file could contain XML, JSON, TXT and BINARY files.
      * @param input is the incoming input stream.
      * @return a stream of DocumentWriteOperation
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) throws Exception {
@@ -174,7 +174,7 @@ public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input) th
      * @param inputName is the input file name, including name and extension. It is used to generate URLs for split
      *                  files.The inputName could either be provided here or in user-defined UriMaker.
      * @return a stream of DocumentWriteOperation
-     * @throws Exception
+     * @throws Exception if the input cannot be split
      */
     @Override
     public Stream<DocumentWriteOperation> splitWriteOperations(InputStream input, String inputName) throws Exception {