rocks.xmpp.extensions.disco

Class DefaultItemProvider

java.lang.Object

rocks.xmpp.extensions.disco.DefaultItemProvider

All Implemented Interfaces:

ResultSetProvider<Item>

public final class DefaultItemProvider
extends Object
implements ResultSetProvider<Item>

A default item provider for Service Discovery. When items are requested via Service Discovery, this class provides the items and if requested with Result Set Management, it also takes care of providing the correct number of items or the total count of items.

This class is a view on a collection, if the underlying collection changes, the view on the collection will yield different results.

See Also:

XEP-0030: Service Discovery 4.2 Items Nodes, XEP-0059: Result Set Management 3. Examples

Constructor Summary

Constructors

Constructor and Description
DefaultItemProvider(Collection<Item> items)

Method Summary

Modifier and Type	Method and Description
int	getItemCount() Gets the total item count.
List<Item>	getItems() Gets all items.
List<Item>	getItems(int index, int maxSize) Gets the items in a specific range (by index).
List<Item>	getItemsAfter(String itemId, int maxSize) Gets the items after a specific item, which is determined by an item id.
List<Item>	getItemsBefore(String itemId, int maxSize) Gets the items before a specific item, which is determined by an item id.
int	indexOf(String itemId) Gets the index of a specific item.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultItemProvider

public DefaultItemProvider(Collection<Item> items)

Method Detail

getItems

public List<Item> getItems()

Description copied from interface: ResultSetProvider

Gets all items. This method is called, if no result set management was included in the query.

Specified by:

getItems in interface ResultSetProvider<Item>

Returns:

The items.

getItemCount

public int getItemCount()

Description copied from interface: ResultSetProvider

Gets the total item count.

Specified by:

getItemCount in interface ResultSetProvider<Item>

Returns:

The item count.

getItems

public List<Item> getItems(int index,
                           int maxSize)

Description copied from interface: ResultSetProvider

Gets the items in a specific range (by index).

Specified by:

getItems in interface ResultSetProvider<Item>

Parameters:

index - The index.

maxSize - The maximal size of items.

Returns:

The items.

getItemsAfter

public List<Item> getItemsAfter(String itemId,
                                int maxSize)

Description copied from interface: ResultSetProvider

Gets the items after a specific item, which is determined by an item id.

Specified by:

getItemsAfter in interface ResultSetProvider<Item>

Parameters:

itemId - The item id.

maxSize - The maximal size of items.

Returns:

The items.

getItemsBefore

public List<Item> getItemsBefore(String itemId,
                                 int maxSize)

Description copied from interface: ResultSetProvider

Gets the items before a specific item, which is determined by an item id.

Specified by:

getItemsBefore in interface ResultSetProvider<Item>

Parameters:

itemId - The item id.

maxSize - The maximal size of items.

Returns:

The items.

indexOf

public int indexOf(String itemId)

Description copied from interface: ResultSetProvider

Gets the index of a specific item.

Specified by:

indexOf in interface ResultSetProvider<Item>

Parameters:

itemId - The item id.

Returns:

The index or -1, if no index could be determined.