de.umass.lastfm
Class PaginatedResult<T>

java.lang.Object
  de.umass.lastfm.PaginatedResult<T>

All Implemented Interfaces:

Iterable<T>

public class PaginatedResult<T>
extends Object
implements Iterable<T>

A PaginatedResult is returned by methods which result set might be so large that it needs to be paginated. Each PaginatedResult contains the total number of result pages, the current page and a Collection of entries for the current page.

Author:

Janni Kovacs

Method Summary

int	getPage() Returns the page number of this result.
Collection<T>	getPageResults() Returns a list of entries of the type T for this page.
int	getTotalPages() Returns the total number of pages available.
boolean	isEmpty() Returns true if this Result contains no elements, which is the case for service calls that would have returned a PaginatedResult but fail.
Iterator<T>	iterator()

Methods inherited from class java.lang.Object

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

Method Detail

getPage

public int getPage()

Returns the page number of this result.

Returns:

page number

getPageResults

public Collection<T> getPageResults()

Returns a list of entries of the type T for this page.

Returns:

page results

getTotalPages

public int getTotalPages()

Returns the total number of pages available.

Returns:

total pages

isEmpty

public boolean isEmpty()

Returns true if this Result contains no elements, which is the case for service calls that would have returned a PaginatedResult but fail.

Returns:

true if this result contains no elements

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>