Skip to content

Commit db34c2e

Browse files
committed
fix a bug in documentation on read(ID[], Transaction)
1 parent d61f4b3 commit db34c2e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/main/java/com/marklogic/client/pojo/PojoRepository.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ public T read(ID id, Transaction transaction)
254254
public PojoPage<T> read(ID[] ids)
255255
throws ForbiddenUserException, FailedRequestException;
256256
/** Within an open transaction,
257-
* read one page of persisted pojos and unmarshall their data into new pojo instances.
257+
* read multiple persisted pojos and unmarshall their data into new pojo instances.
258258
* If at least one instance is found but others are not, ignores the instances not found.
259259
* While this returns a PojoPage, the PageSize will match the number of instances found,
260260
* and will ignore getPageLength(). To paginate, send a smaller set of ids at a time.
@@ -263,9 +263,9 @@ public PojoPage<T> read(ID[] ids)
263263
* @param transaction the transaction in which this read is participating
264264
* (will open a read lock on each document matched that is released when the
265265
* transaction is committed or rolled back)
266-
* @return a page of instances of the correct type populated with the persisted data.
267-
* Since this call may match a large set, only one page of {@link #getPageLength()}
268-
* is returned just like calls to {@link #search(PojoQueryDefinition, long) search}
266+
* @return a set of instances of the correct type populated with the persisted data.
267+
* Since this call produces a finite set, only one page is returned and therefore
268+
* PojoPage pagination methods will not be helpful as they would be from calls to search.
269269
*/
270270
public PojoPage<T> read(ID[] ids, Transaction transaction)
271271
throws ForbiddenUserException, FailedRequestException;

0 commit comments

Comments
 (0)