Skip to content

Commit 5bee686

Browse files
author
ehennum
committed
annotation fixup and links to wiki in JavaDoc #1250
1 parent 9f7ed88 commit 5bee686

File tree

6 files changed

+29
-3
lines changed

6 files changed

+29
-3
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
* <p>Specify a failure listener to handle any errors during retrieval.</p>
9797
*
9898
* @param <T> the Java class that stores a batch of retrieved roles
99+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Row-Batcher">Exporting a TDE View</a>
99100
*/
100101
public interface RowBatcher<T> extends Batcher {
101102
/**

marklogic-client-api/src/main/java/com/marklogic/client/dataservices/ExecCaller.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
/**
2323
* Provides an interface for calling an endpoint that doesn't take
2424
* input data structures or return output data structures.
25+
*
26+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Data-Services-for-IO#exec-endpoints">Exec endpoints</a>
2527
*/
2628
public interface ExecCaller extends IOEndpoint {
2729
/**
@@ -80,6 +82,8 @@ static ExecCaller on(DatabaseClient client, JSONWriteHandle apiDecl) {
8082
* data structure or return output data structures.
8183
*
8284
* Call awaitCompletion() to start making calls.
85+
*
86+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Bulk-Data-Services">Bulk Data Services</a>
8387
*/
8488
interface BulkExecCaller extends BulkIOEndpointCaller {
8589
void setErrorListener(ErrorListener errorListener);

marklogic-client-api/src/main/java/com/marklogic/client/dataservices/InputCaller.java

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323

2424
/**
2525
* Provides an interface for calling an endpoint that takes input data structures.
26+
*
27+
* @param <I> The representation for document input
28+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Data-Services-for-IO#input-endpoints">Input endpoints</a>
2629
*/
2730
public interface InputCaller<I> extends IOEndpoint {
2831
/**
@@ -79,9 +82,12 @@ static <I> InputCaller<I> on(DatabaseClient client, JSONWriteHandle apiDecl, Buf
7982
BulkInputCaller<I> bulkCaller(CallContext[] callContexts, int threadCount);
8083

8184
/**
82-
* Provides an interface for completing a unit of work
83-
* by repeated calls to the input endpoint.
84-
*/
85+
* Provides an interface for completing a unit of work
86+
* by repeated calls to the input endpoint.
87+
*
88+
* @param <I> The representation for document input
89+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Bulk-Data-Services">Bulk Data Services</a>
90+
*/
8591
interface BulkInputCaller<I> extends BulkIOEndpointCaller {
8692
/**
8793
* Accepts an input item for the endpoint. Items are queued

marklogic-client-api/src/main/java/com/marklogic/client/dataservices/InputEndpoint.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ private BulkLocal(EndpointLocal<O> endpoint) {
7878
* Provides an interface for completing a unit of work
7979
* by repeated calls to the input endpoint.
8080
*/
81+
@Deprecated
8182
interface BulkInputCaller extends InputCaller.BulkInputCaller<InputStream> {
8283
}
8384
}

marklogic-client-api/src/main/java/com/marklogic/client/dataservices/InputOutputCaller.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626
/**
2727
* Provides an interface for calling an endpoint that takes input data structures and
2828
* returns output data structures.
29+
*
30+
* @param <I> The representation for document input
31+
* @param <O> The representation for document output
32+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Data-Services-for-IO#input-output-endpoints">Input-output endpoints</a>
2933
*/
3034
public interface InputOutputCaller<I,O> extends IOEndpoint {
3135
/**
@@ -92,6 +96,10 @@ static <I,O> InputOutputCaller<I,O> on(
9296
/**
9397
* Provides an interface for completing a unit of work
9498
* by repeated calls to the input-output endpoint.
99+
*
100+
* @param <I> The representation for document input
101+
* @param <O> The representation for document output
102+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Bulk-Data-Services">Bulk Data Services</a>
95103
*/
96104
interface BulkInputOutputCaller<I,O> extends BulkIOEndpointCaller {
97105
/**

marklogic-client-api/src/main/java/com/marklogic/client/dataservices/OutputCaller.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424

2525
/**
2626
* Provides an interface for calling an endpoint that returns output data structures.
27+
*
28+
* @param <O> The representation for document output
29+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Data-Services-for-IO#output-endpoints">Output endpoints</a>
2730
*/
2831
public interface OutputCaller<O> extends IOEndpoint {
2932
/**
@@ -84,6 +87,9 @@ static <O> OutputCaller<O> on(
8487
/**
8588
* Provides an interface for completing a unit of work
8689
* by repeated calls to the output endpoint.
90+
*
91+
* @param <O> The representation for document output
92+
* @see <a href="https://github.com/marklogic/java-client-api/wiki/Bulk-Data-Services">Bulk Data Services</a>
8793
*/
8894
interface BulkOutputCaller<O> extends BulkIOEndpointCaller {
8995
/**

0 commit comments

Comments
 (0)