PagedList (Microsoft Azure Libraries for Java)

java.lang.Object
- com.microsoft.azure.PagedList<E>

Type Parameters:

E - the element type.

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>
```
public abstract class PagedList<E>
extends Object
implements List<E>
```
Defines a list response from a paging operation. The pages are lazy initialized when an instance of this class is iterated.

Constructor Summary

Constructors
Constructor and Description

PagedList()
Creates an instance of Pagedlist.

PagedList(Page<E> page)
Creates an instance of PagedList from a Page response.

Constructors
Constructor and Description
`PagedList()` Creates an instance of Pagedlist.
`PagedList(Page<E> page)` Creates an instance of PagedList from a `Page` response.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`void`	`add(int index, E element)`
`boolean`	`addAll(Collection<? extends E> c)`
`boolean`	`addAll(int index, Collection<? extends E> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`Page<E>`	`currentPage()` Gets the latest page fetched.
`E`	`get(int index)`
`boolean`	`hasNextPage()` If there are more pages available.
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`Iterator<E>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(int index)`
`void`	`loadAll()` Keep loading the next page from the next page link until all items are loaded.
`void`	`loadNextPage()` Loads a page from next page link.
`abstract Page<E>`	`nextPage(String nextPageLink)` Override this method to load the next page of items from a next page link.
`E`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`E`	`set(int index, E element)`
`protected void`	`setCurrentPage(Page<E> currentPage)` Sets the current page.
`int`	`size()`
`List<E>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

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

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - PagedList
```
public PagedList()
```
    Creates an instance of Pagedlist.
  - PagedList
```
public PagedList(Page<E> page)
```
    Creates an instance of PagedList from a Page response.
    
    Parameters:
    
    page - the Page object.
- Method Detail
  - nextPage
```
public abstract Page<E> nextPage(String nextPageLink)
                          throws RestException,
                                 IOException
```
    Override this method to load the next page of items from a next page link.
    
    Parameters:
    
    nextPageLink - the link to get the next page of items.
    
    Returns:
    
    the Page object storing a page of items and a link to the next page.
    
    Throws:
    
    RestException - thrown if an error is raised from Azure.
    
    IOException - thrown if there's any failure in deserialization.
  - hasNextPage
```
public boolean hasNextPage()
```
    If there are more pages available.
    
    Returns:
    
    true if there are more pages to load. False otherwise.
  - loadNextPage
```
public void loadNextPage()
```
    Loads a page from next page link. The exceptions are wrapped into Java Runtime exceptions.
  - loadAll
```
public void loadAll()
```
    Keep loading the next page from the next page link until all items are loaded.
  - currentPage
```
public Page<E> currentPage()
```
    Gets the latest page fetched.
    
    Returns:
    
    the latest page.
  - setCurrentPage
```
protected void setCurrentPage(Page<E> currentPage)
```
    Sets the current page.
    
    Parameters:
    
    currentPage - the current page.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface List<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface List<E>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface List<E>
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface List<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface List<E>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface List<E>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface List<E>
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface List<E>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface List<E>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface List<E>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface List<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface List<E>
  - set
```
public E set(int index,
             E element)
```
    Specified by:
    
    set in interface List<E>
  - add
```
public void add(int index,
                E element)
```
    Specified by:
    
    add in interface List<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface List<E>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<E>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<E>
  - subList
```
public List<E> subList(int fromIndex,
                       int toIndex)
```
    Specified by:
    
    subList in interface List<E>

Class PagedList<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

PagedList

PagedList

Method Detail

nextPage

hasNextPage

loadNextPage

loadAll

currentPage

setCurrentPage

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList