Page (Atlassian Marketplace Client 2.0.0-m1 API)

java.lang.Object
- com.atlassian.marketplace.client.api.Page<T>

All Implemented Interfaces:

Iterable<T>
```
public abstract class Page<T>
extends Object
implements Iterable<T>
```
A subset of items returned by a query. The maximum size of the subset is determined by the limit parameter used in the query, or by the server's maximum result set size, whichever is lower.
The items themselves are accessed by treating the page as an Iterable.
To get the next or previous page of query results, if any, pass a PageReference obtained from getNext() or getPrevious() to the client's generic MarketplaceClient.getMore(com.atlassian.marketplace.client.api.PageReference<T>) method. for the type of items. For instance, for plugin listings:
```
     Page<AddonSummary> aPage = client.addons().find(addonQuery);
     if (aPage.getNext().isDefined())
     {
         for (PageReference<AddonSummary> next: aPage.getNext())
         {
             Page<AddonSummary> nextPage = client.getMore(next);
         }
     }
 
```

Field Summary

Fields
Modifier and Type Field and Description

protected PageReader<T> reader

Fields
Modifier and Type	Field and Description
`protected PageReader<T>`	`reader`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Page(Iterable<T> items, int totalSize, PageReader<T> reader)

Constructors
Modifier	Constructor and Description
`protected`	`Page(Iterable<T> items, int totalSize, PageReader<T> reader)`

Method Summary

Methods
Modifier and Type	Method and Description
`static <T> Page<T>`	`empty()` Returns a Page containing no items, with no server URI (`getReference()`, `getNext()`, and `getPrevious()` will all return `Option.none()`).
`static <T> Page<T>`	`empty(Class<T> type)` Returns a Page containing no items, with no server URI (`getReference()`, `getNext()`, and `getPrevious()` will all return `Option.none()`).
`static <T> Page<T>`	`fromItems(Iterable<T> items)` Returns a Page from a fixed list of items, with no server URI (`getReference()`, `getNext()`, and `getPrevious()` will all return `Option.none()`).
`abstract com.atlassian.fugue.Option<PageReference<T>>`	`getNext()` If there are other items after this subset in the full result set, returns a `PageReference` allowing you to query the next page; otherwise returns `Option.none()`.
`int`	`getOffset()` Shortcut for `getReference().get().getOffset()`, but returns zero if `getReference()` is `none()`.
`abstract com.atlassian.fugue.Option<PageReference<T>>`	`getPrevious()` If there are other items before this subset in the full result set, returns a `PageReference` allowing you to query the previous page; otherwise returns `Option.none()`.
`abstract com.atlassian.fugue.Option<PageReference<T>>`	`getReference()` Returns a reference to the address of this query page on the server allowing it to be requeried in the future, or `Option.none()` if it does not exist on the server.
`Iterator<T>`	`iterator()`
`int`	`size()` The number of items on this page.
`int`	`totalSize()` The number of items in the entire result set, of which this page is a subset.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - reader
```
protected final PageReader<T> reader
```
- Constructor Detail
  - Page
```
protected Page(Iterable<T> items,
    int totalSize,
    PageReader<T> reader)
```
- Method Detail
  - empty
```
public static <T> Page<T> empty()
```
    Returns a Page containing no items, with no server URI (getReference(), getNext(), and getPrevious() will all return Option.none()).
  - empty
```
public static <T> Page<T> empty(Class<T> type)
```
    Returns a Page containing no items, with no server URI (getReference(), getNext(), and getPrevious() will all return Option.none()).
  - fromItems
```
public static <T> Page<T> fromItems(Iterable<T> items)
```
    Returns a Page from a fixed list of items, with no server URI (getReference(), getNext(), and getPrevious() will all return Option.none()).
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T>
  - size
```
public int size()
```
    The number of items on this page.
  - totalSize
```
public int totalSize()
```
    The number of items in the entire result set, of which this page is a subset.
  - getReference
```
public abstract com.atlassian.fugue.Option<PageReference<T>> getReference()
```
    Returns a reference to the address of this query page on the server allowing it to be requeried in the future, or Option.none() if it does not exist on the server.
  - getPrevious
```
public abstract com.atlassian.fugue.Option<PageReference<T>> getPrevious()
```
    If there are other items before this subset in the full result set, returns a PageReference allowing you to query the previous page; otherwise returns Option.none().
  - getNext
```
public abstract com.atlassian.fugue.Option<PageReference<T>> getNext()
```
    If there are other items after this subset in the full result set, returns a PageReference allowing you to query the next page; otherwise returns Option.none().
  - getOffset
```
public int getOffset()
```
    Shortcut for getReference().get().getOffset(), but returns zero if getReference() is none().

Class Page<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

reader

Constructor Detail

Page

Method Detail

empty

empty

fromItems

iterator

size

totalSize

getReference

getPrevious

getNext

getOffset