com.bandwidth.sdk.model

Class ResourceList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

com.bandwidth.sdk.model.ResourceList<E>

Type Parameters:

E - The generic type.

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess

public class ResourceList<E>
extends ArrayList<E>

The ResourceList class is an ArraryList wrapper, but provides pagination for the BW API resource lists

Author:

smitchell

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<E>	clazz
protected String	firstLink
protected int	index
protected String	nextLink
protected int	page
protected String	previousLink
protected String	resourceUri
protected int	size

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ResourceList(int page, int size, String resourceUri, Class<E> clazz)
ResourceList(String resourceUri, Class<E> clazz)

Method Summary

Methods

Modifier and Type	Method and Description
Client	getClient()
String	getFirstLink()
String	getNextLink()
protected void	getNextPage() This method updates the page value, creates the params for the API call and clears the current list
protected void	getPage(org.json.simple.JSONObject params) This method makes the API call to get the list value for the specified resource.
String	getPreviousLink()
RestResponse	getResponse()
void	initialize() initializes ArrayList with first page from BW API
Iterator<E>	iterator() Customer iterator calls out to BW API when there is more data to retrieve
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
void	setClient(Client client)
void	setFirstLink(String firstLink)
void	setNextLink(String nextLink)
void	setPreviousLink(String previousLink)
void	setResponse(RestResponse response)

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Field Detail

page

protected int page

size

protected int size

index

protected int index

previousLink

protected String previousLink

nextLink

protected String nextLink

firstLink

protected String firstLink

clazz

protected Class<E> clazz

resourceUri

protected String resourceUri

Constructor Detail

ResourceList

public ResourceList(String resourceUri,
            Class<E> clazz)

ResourceList

public ResourceList(int page,
            int size,
            String resourceUri,
            Class<E> clazz)

Method Detail

initialize

public void initialize()

initializes ArrayList with first page from BW API

iterator

public Iterator<E> iterator()

Customer iterator calls out to BW API when there is more data to retrieve

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface List<E>

Overrides:

iterator in class ArrayList<E>

getNextPage

protected void getNextPage()

This method updates the page value, creates the params for the API call and clears the current list

getPage

protected void getPage(org.json.simple.JSONObject params)

This method makes the API call to get the list value for the specified resource. It loads the return from the API into the arrayList, updates the index if necessary and sets the new link values

Parameters:

params - the params

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class ArrayList<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class ArrayList<E>

getPreviousLink

public String getPreviousLink()

setPreviousLink

public void setPreviousLink(String previousLink)

getNextLink

public String getNextLink()

setNextLink

public void setNextLink(String nextLink)

getFirstLink

public String getFirstLink()

setFirstLink

public void setFirstLink(String firstLink)

getResponse

public RestResponse getResponse()

setResponse

public void setResponse(RestResponse response)

getClient

public Client getClient()

setClient

public void setClient(Client client)