rocks.xmpp.extensions.rsm.model

Class ResultSet

java.lang.Object

rocks.xmpp.extensions.rsm.model.ResultSet

public final class ResultSet
extends Object

The implementation of the <set/> element in the http://jabber.org/protocol/rsm namespace.

Author:

Christian Schudt

See Also:

XEP-0059: Result Set Management, XML Schema

Method Summary

Modifier and Type	Method and Description
static ResultSet	forFirstPage(int itemCount) Gets a result set, which requests the first page.
static ResultSet	forIndex(int itemCount, int index) Gets a result set, which starts at a particular index.
static ResultSet	forItemCount() Gets a result set, which gets the item count of a result without retrieving the items themselves.
static ResultSet	forLastPage(int itemCount) Gets a result set, which requests the last page.
static ResultSet	forLimit(int limit) Gets a result set, which limits the number of items of a result to be returned.
static ResultSet	forNextPage(int itemCount, String id) Gets a result set, which requests the next page after a specified item.
static ResultSet	forPreviousPage(int itemCount, String id) Gets a result set, which requests the previous page before a specified item.
String	getFirstItem() Gets the first item.
Integer	getFirstItemIndex() Gets the first item's index.
Integer	getItemCount() Gets the item count of a result set.
String	getLastItem() Gets the last item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forLimit

public static ResultSet forLimit(int limit)

Gets a result set, which limits the number of items of a result to be returned.

Parameters:

limit - The limit, i.e. the maximum number of items.

Returns:

The result set.

See Also:

2.1 Limiting the Number of Items

forFirstPage

public static ResultSet forFirstPage(int itemCount)

Gets a result set, which requests the first page.

Parameters:

itemCount - The item count per page.

Returns:

The result set.

See Also:

2.2 Paging Forwards Through a Result Set

forNextPage

public static ResultSet forNextPage(int itemCount,
                                    String id)

Gets a result set, which requests the next page after a specified item.

Parameters:

itemCount - The item count per page.

id - The id of the last item of the previous page. This should be the getLastItem() ()} of the previous page.

Returns:

The result set.

See Also:

2.2 Paging Forwards Through a Result Set

forPreviousPage

public static ResultSet forPreviousPage(int itemCount,
                                        String id)

Gets a result set, which requests the previous page before a specified item.

Parameters:

itemCount - The item count per page.

id - The id of the first item of the next page. This should be the getFirstItem() of the next page.

Returns:

The result set.

See Also:

2.3 Paging Backwards Through a Result Set

forLastPage

public static ResultSet forLastPage(int itemCount)

Gets a result set, which requests the last page.

Parameters:

itemCount - The item count per page.

Returns:

The result set.

See Also:

2.5 Requesting the Last Page in a Result Set

forIndex

public static ResultSet forIndex(int itemCount,
                                 int index)

Gets a result set, which starts at a particular index.

Parameters:

itemCount - The item count per page.

index - The index to start from.

Returns:

The result set.

See Also:

2.6 Retrieving a Page Out of Order

forItemCount

public static ResultSet forItemCount()

Gets a result set, which gets the item count of a result without retrieving the items themselves.

Returns:

The result set.

See Also:

2.7 Getting the Item Count

getItemCount

public Integer getItemCount()

Gets the item count of a result set.

Returns:

The item count.

getFirstItem

public String getFirstItem()

Gets the first item.

Returns:

The first item.

getFirstItemIndex

public Integer getFirstItemIndex()

Gets the first item's index.

Returns:

The first item's index.

getLastItem

public String getLastItem()

Gets the last item.

Returns:

The last item.