Skip to content

Commit 1759fef

Browse files
vivekmuniyandivivekmuniyandi
committed
Issue #385 - Added javadoc messages for shortcut methods
(cherry picked from commit 0a51da9)
1 parent 6a76a36 commit 1759fef

13 files changed

+254
-83
lines changed

‎src/main/java/com/marklogic/client/admin/ExtensionLibrariesManager.java‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,12 @@ public ExtensionLibraryDescriptor[] list(String directory)
4545

4646
/**
4747
* Reads the contents of a library asset as an object of an IO class.
48-
*
49-
* The IO class must have been registered before creating the database client.
50-
* By default, standard Java IO classes for document content are registered.
48+
*
49+
* The IO class must have been registered before creating the database client.
50+
* By default, the provided handles that implement
51+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
52+
*
53+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
5154
*
5255
* @param libraryPath the path to the library
5356
* @param as the IO class for reading the library asset
@@ -58,9 +61,12 @@ public <T> T readAs(String libraryPath, Class<T> as)
5861
throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException;
5962
/**
6063
* Reads the contents of a library asset as an object of an IO class.
61-
*
62-
* The IO class must have been registered before creating the database client.
63-
* By default, standard Java IO classes for document content are registered.
64+
*
65+
* The IO class must have been registered before creating the database client.
66+
* By default, the provided handles that implement
67+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
68+
*
69+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
6470
*
6571
* @param libraryDescriptor a descriptor that locates the library
6672
* @param as the IO class for reading the library asset
@@ -94,7 +100,10 @@ public <T extends AbstractReadHandle> T read(ExtensionLibraryDescriptor libraryD
94100
* as an object of an IO class.
95101
*
96102
* The IO class must have been registered before creating the database client.
97-
* By default, standard Java IO classes for document content are registered.
103+
* By default, the provided handles that implement
104+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
105+
*
106+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
98107
*
99108
* @param libraryPath The path at which to install the library.
100109
* @param content an IO representation of the library asset
@@ -106,7 +115,10 @@ public void writeAs(String libraryPath, Object content)
106115
* as an object of an IO class.
107116
*
108117
* The IO class must have been registered before creating the database client.
109-
* By default, standard Java IO classes for document content are registered.
118+
* By default, the provided handles that implement
119+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
120+
*
121+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
110122
*
111123
* @param libraryDescriptor The descriptory which locates where to install the library.
112124
* @param content an IO representation of the library asset

‎src/main/java/com/marklogic/client/admin/QueryOptionsManager.java‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ public interface QueryOptionsManager {
3434
* XML representation provided as an object of an IO class.
3535
*
3636
* The IO class must have been registered before creating the database client.
37-
* By default, standard Java IO classes for document content are registered.
37+
* By default, the provided handles that implement
38+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
39+
*
40+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
3841
*
3942
* @param format whether to provide the list in a JSON or XML representation
4043
* @param as the IO class for reading the list of options
@@ -60,10 +63,16 @@ public <T extends QueryOptionsListReadHandle> T optionsList(T listHandle)
6063
/**
6164
* Fetch a query options configuration from the REST Server by name.
6265
*
63-
* @param name the name of options configuration stored on MarkLogic REST instance.
66+
* The IO class must have been registered before creating the database client.
67+
* By default, the provided handles that implement
68+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
69+
*
70+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
71+
*
72+
* @param name the name of options configuration stored on MarkLogic REST instance.
6473
* @param format whether to provide the options in a JSON or XML representation
6574
* @param as the IO class for reading the query options
66-
* @param <T> the type of object that will be returned by the handle registered for it
75+
* @param <T> the type of object that will be returned by the handle registered for it
6776
* @return an object of the IO class with the query options
6877
*/
6978
public <T> T readOptionsAs(String name, Format format, Class<T> as)
@@ -86,7 +95,10 @@ public <T extends QueryOptionsReadHandle> T readOptions(String name, T queryOpti
8695
* XML representation provided as an object of an IO class.
8796
*
8897
* The IO class must have been registered before creating the database client.
89-
* By default, standard Java IO classes for document content are registered.
98+
* By default, the provided handles that implement
99+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
100+
*
101+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
90102
*
91103
* @param name name given to the QueryOptions for use in runtime queries
92104
* @param format whether the options are provided in a JSON or XML representation

‎src/main/java/com/marklogic/client/admin/ResourceExtensionsManager.java‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ public interface ResourceExtensionsManager {
3535
* in a JSON or XML representation provided as an object of an IO class.
3636
*
3737
* The IO class must have been registered before creating the database client.
38-
* By default, standard Java IO classes for document content are registered.
38+
* By default, the provided handles that implement
39+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
40+
*
41+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
3942
*
4043
* @param format whether to provide the list in a JSON or XML representation
4144
* @param as the IO class for reading the list of resource service extensions
@@ -48,7 +51,10 @@ public interface ResourceExtensionsManager {
4851
* in a JSON or XML representation provided as an object of an IO class.
4952
*
5053
* The IO class must have been registered before creating the database client.
51-
* By default, standard Java IO classes for document content are registered.
54+
* By default, the provided handles that implement
55+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
56+
*
57+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
5258
*
5359
* @param format whether to provide the list in a JSON or XML representation
5460
* @param as the IO class for reading the list of resource service extensions
@@ -80,7 +86,10 @@ public interface ResourceExtensionsManager {
8086
* in a textual representation provided as an object of an IO class.
8187
*
8288
* The IO class must have been registered before creating the database client.
83-
* By default, standard Java IO classes for document content are registered.
89+
* By default, the provided handles that implement
90+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
91+
*
92+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
8493
*
8594
* @param resourceName the name of the resource
8695
* @param as the IO class for reading the source code as text
@@ -103,7 +112,10 @@ public interface ResourceExtensionsManager {
103112
* in a textual representation provided as an object of an IO class.
104113
*
105114
* The IO class must have been registered before creating the database client.
106-
* By default, standard Java IO classes for document content are registered.
115+
* By default, the provided handles that implement
116+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
117+
*
118+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
107119
*
108120
* @param resourceName the name of the resource
109121
* @param source an IO representation of the source code

‎src/main/java/com/marklogic/client/admin/TransformExtensionsManager.java‎

Lines changed: 59 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ public interface TransformExtensionsManager {
4343
* in a JSON or XML representation provided as an object of an IO class.
4444
*
4545
* The IO class must have been registered before creating the database client.
46-
* By default, standard Java IO classes for document content are registered.
46+
* By default, the provided handles that implement
47+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
48+
*
49+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
4750
*
4851
* @param format whether to provide the list in a JSON or XML representation
4952
* @param as the IO class for reading the list of transform extensions
@@ -56,7 +59,10 @@ public interface TransformExtensionsManager {
5659
* in a JSON or XML representation provided as an object of an IO class.
5760
*
5861
* The IO class must have been registered before creating the database client.
59-
* By default, standard Java IO classes for document content are registered.
62+
* By default, the provided handles that implement
63+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
64+
*
65+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
6066
*
6167
* @param format whether to provide the list in a JSON or XML representation
6268
* @param as the IO class for reading the list of transform extensions
@@ -90,7 +96,10 @@ public <T extends StructureReadHandle> T listTransforms(T listHandle, boolean re
9096
* in an XML representation provided as an object of an IO class.
9197
*
9298
* The IO class must have been registered before creating the database client.
93-
* By default, standard Java IO classes for document content are registered.
99+
* By default, the provided handles that implement
100+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
101+
*
102+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
94103
*
95104
* @param transformName the name of the transform
96105
* @param as the IO class for reading the source code as XML
@@ -115,7 +124,10 @@ public <T extends XMLReadHandle> T readXSLTransform(String transformName, T sour
115124
* in a textual representation provided as an object of an IO class.
116125
*
117126
* The IO class must have been registered before creating the database client.
118-
* By default, standard Java IO classes for document content are registered.
127+
* By default, the provided handles that implement
128+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
129+
*
130+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
119131
*
120132
* @param transformName the name of the transform
121133
* @param as the IO class for reading the source code as text
@@ -140,7 +152,10 @@ public <T extends TextReadHandle> T readXQueryTransform(String transformName, T
140152
* in a textual representation provided as an object of an IO class.
141153
*
142154
* The IO class must have been registered before creating the database client.
143-
* By default, standard Java IO classes for document content are registered.
155+
* By default, the provided handles that implement
156+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
157+
*
158+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
144159
*
145160
* @param transformName the name of the transform
146161
* @param as the IO class for reading the source code as text
@@ -166,7 +181,10 @@ public <T extends TextReadHandle> T readJavascriptTransform(String transformName
166181
* in an XML representation provided as an object of an IO class.
167182
*
168183
* The IO class must have been registered before creating the database client.
169-
* By default, standard Java IO classes for document content are registered.
184+
* By default, the provided handles that implement
185+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
186+
*
187+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
170188
*
171189
* @param transformName the name of the transform
172190
* @param source an IO representation of the source code
@@ -178,7 +196,10 @@ public void writeXSLTransformAs(String transformName, Object source)
178196
* in an XML representation provided as an object of an IO class.
179197
*
180198
* The IO class must have been registered before creating the database client.
181-
* By default, standard Java IO classes for document content are registered.
199+
* By default, the provided handles that implement
200+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
201+
*
202+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
182203
*
183204
* @param transformName the name of the transform
184205
* @param metadata the metadata about the transform
@@ -218,7 +239,10 @@ public void writeXSLTransform(String transformName, XMLWriteHandle sourceHandle,
218239
* in a textual representation provided as an object of an IO class.
219240
*
220241
* The IO class must have been registered before creating the database client.
221-
* By default, standard Java IO classes for document content are registered.
242+
* By default, the provided handles that implement
243+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
244+
*
245+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
222246
*
223247
* @param transformName the name of the transform
224248
* @param source an IO representation of the source code
@@ -230,7 +254,10 @@ public void writeXQueryTransformAs(String transformName, Object source)
230254
* in a textual representation provided as an object of an IO class.
231255
*
232256
* The IO class must have been registered before creating the database client.
233-
* By default, standard Java IO classes for document content are registered.
257+
* By default, the provided handles that implement
258+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
259+
*
260+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
234261
*
235262
* @param transformName the name of the transform
236263
* @param metadata the metadata about the transform
@@ -266,28 +293,34 @@ public void writeXQueryTransform(String transformName, TextWriteHandle sourceHan
266293
throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException;
267294

268295
/**
269-
* Installs a transform implemented in XQuery
270-
* in a textual representation provided as an object of an IO class.
271-
*
272-
* The IO class must have been registered before creating the database client.
273-
* By default, standard Java IO classes for document content are registered.
274-
*
275-
* @param transformName the name of the transform
276-
* @param source an IO representation of the source code
296+
* Installs a transform implemented in XQuery
297+
* in a textual representation provided as an object of an IO class.
298+
*
299+
* The IO class must have been registered before creating the database client.
300+
* By default, the provided handles that implement
301+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
302+
*
303+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
304+
*
305+
* @param transformName the name of the transform
306+
* @param source an IO representation of the source code
277307
*/
278308

279309
public void writeJavascriptTransformAs(String transformName, Object source)
280310
throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException;
281311
/**
282-
* Installs a transform implemented in Javascript
283-
* in a textual representation provided as an object of an IO class.
284-
*
285-
* The IO class must have been registered before creating the database client.
286-
* By default, standard Java IO classes for document content are registered.
287-
*
288-
* @param transformName the name of the transform
289-
* @param metadata the metadata about the transform
290-
* @param source an IO representation of the source code
312+
* Installs a transform implemented in Javascript
313+
* in a textual representation provided as an object of an IO class.
314+
*
315+
*The IO class must have been registered before creating the database client.
316+
* By default, the provided handles that implement
317+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
318+
*
319+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
320+
*
321+
* @param transformName the name of the transform
322+
* @param metadata the metadata about the transform
323+
* @param source an IO representation of the source code
291324
*/
292325
public void writeJavascriptTransformAs(String transformName, ExtensionMetadata metadata, Object source)
293326
throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException;

0 commit comments

Comments
 (0)