Skip to content

Commit 699655f

Browse files
llingllinggit
authored andcommitted
fixup JavaDoc issue for splitters #1245
1 parent 155524d commit 699655f

File tree

6 files changed

+16
-5
lines changed

6 files changed

+16
-5
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,8 @@ public interface UriMaker extends Splitter.UriMaker {
648648
/**
649649
* Generates URI for each split
650650
* @param num the count of each split
651-
* @param handle the handle which contains the content of each split
651+
* @param handle the handle which contains the content of each split. It could be utilized to make a meaningful
652+
* document URI.
652653
* @return the generated URI of current split
653654
*/
654655
String makeUri(long num, JSONWriteHandle handle);

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,8 @@ public interface UriMaker extends Splitter.UriMaker {
318318
/**
319319
* Generates URI for each split
320320
* @param num the count of each split
321-
* @param handle the handle which contains the content of each split
321+
* @param handle the handle which contains the content of each split. It could be utilized to make a meaningful
322+
* document URI.
322323
* @return the generated URI of current split
323324
*/
324325
String makeUri(long num, JacksonHandle handle);

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,8 @@ public interface UriMaker extends Splitter.UriMaker {
202202
/**
203203
* Generates URI for each split
204204
* @param num the count of each split
205-
* @param handle the handle which contains the content of each split
205+
* @param handle the handle which contains the content of each split. It could be utilized to make a meaningful
206+
* document URI.
206207
* @return the generated URI of current split
207208
*/
208209
String makeUri(long num, StringHandle handle);

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,12 @@ public long getCount() {
127127
* UriMaker which generates URI for each split file
128128
*/
129129
public interface UriMaker extends Splitter.UriMaker {
130+
/**
131+
*
132+
* @param handle the handle which contains the content of each split. It could be utilized to make a meaningful
133+
* document URI.
134+
* @return the generated URI of current split
135+
*/
130136
String makeUri(InputStreamHandle handle);
131137
}
132138

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,8 @@ public interface UriMaker extends Splitter.UriMaker {
596596
/**
597597
* Generates URI for each split
598598
* @param num the count of each split
599-
* @param handle the handle which contains the content of each split
599+
* @param handle the handle which contains the content of each split. It could be utilized to make a meaningful
600+
* document URI.
600601
* @return the generated URI of current split
601602
*/
602603
String makeUri(long num, XMLWriteHandle handle);

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,8 @@ public interface UriMaker extends Splitter.UriMaker {
460460
* Generates URI for each split
461461
* @param num the count of each split
462462
* @param entryName the name of each entry in the zip file
463-
* @param handle the handle which contains the content of each split
463+
* @param handle the handle which contains the content of each split. It could be utilized to make a meaningful
464+
* document URI.
464465
* @return the generated URI of current split
465466
*/
466467
String makeUri(long num, String entryName, BytesHandle handle);

0 commit comments

Comments
 (0)