LDAP-128: Improved javadoc documentation of PagedResults and cookies.
This commit is contained in:
@@ -47,7 +47,8 @@ public class PagedResultsCookie {
|
||||
/**
|
||||
* Get the cookie.
|
||||
*
|
||||
* @return the cookie.
|
||||
* @return the cookie. This value may be <code>null</code>, indicating that there are no more requests,
|
||||
* or that the control wasn't supported by the server.
|
||||
*/
|
||||
public byte[] getCookie() {
|
||||
if (cookie != null) {
|
||||
|
||||
@@ -84,7 +84,10 @@ public class PagedResultsDirContextProcessor extends AbstractFallbackRequestAndR
|
||||
/**
|
||||
* Get the cookie.
|
||||
*
|
||||
* @return the cookie.
|
||||
* @return the cookie. The cookie will always be set after at leas one query, however the actual cookie content
|
||||
* can be <code>null</code>, indicating that there are no more results, in which case {@link #hasMore()} will return
|
||||
* <code>false</code>.
|
||||
* @see #hasMore()
|
||||
*/
|
||||
public PagedResultsCookie getCookie() {
|
||||
return cookie;
|
||||
|
||||
Reference in New Issue
Block a user