com.atlassian.confluence.rest.api.model
Class RestList<T>

java.lang.Object
  com.atlassian.confluence.rest.api.model.RestObject
      com.atlassian.confluence.rest.api.model.RestList<T>

Type Parameters:

T -

All Implemented Interfaces:

PageResponse<T>, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

@ExperimentalApi
public final class RestList<T>
extends RestObject
implements PageResponse<T>, java.util.List<T>

The RestList participates in our collection serialization by jackson, and allows collections to be enriched with extra properties during serialization. It wraps a pageResponse, and allows extra fields to be added as jsonProperties. This map of properties is added to by the property enrichers, and is ultimately used by the RestEntitySerializer to convert the object to json

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.rest.api.model.RestObject

RestObject.Properties

Field Summary

Fields inherited from class com.atlassian.confluence.rest.api.model.RestObject

jsonProperties

Constructor Summary

protected

RestList()

Method Summary

void	add(int index, T element)
boolean	add(java.lang.Object o)
boolean	addAll(java.util.Collection c)
boolean	addAll(int index, java.util.Collection<? extends T> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
static <T> RestList<T>	createRestList(PageRequest request, java.util.List<T> results, boolean hasMore)
static <T> RestList<T>	createRestList(PageRequest pageRequest, PageResponse<T> pageResponse)
static <T> RestList<T>	createRestList(PageResponse<T> pageResponse)
T	get(int index)
PageRequest	getPageRequest()
PageResponse<T>	getPageResponse()
java.util.List<T>	getResults()
boolean	hasMore() Indicates whether the source has more results after this page.
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<T>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<T>	listIterator()
java.util.ListIterator<T>	listIterator(int index)
T	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
T	set(int index, T element)
int	size()
java.util.List<T>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] a)
java.lang.String	toString()

Methods inherited from class com.atlassian.confluence.rest.api.model.RestObject

getProperties, getProperty, hasProperty, putProperties, putProperty, putProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

RestList

protected RestList()

Method Detail

createRestList

public static <T> RestList<T> createRestList(PageResponse<T> pageResponse)

createRestList

public static <T> RestList<T> createRestList(PageRequest pageRequest,
                                             PageResponse<T> pageResponse)

createRestList

public static <T> RestList<T> createRestList(PageRequest request,
                                             java.util.List<T> results,
                                             boolean hasMore)

getPageRequest

public PageRequest getPageRequest()

Specified by:

getPageRequest in interface PageResponse<T>

Returns:

the request used to produce this response

getPageResponse

public PageResponse<T> getPageResponse()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.List<T>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.List<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.List<T>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.List<T>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends T> c)

Specified by:

addAll in interface java.util.List<T>

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.List<T>

get

public T get(int index)

Specified by:

get in interface java.util.List<T>

set

public T set(int index,
             T element)

Specified by:

set in interface java.util.List<T>

add

public void add(int index,
                T element)

Specified by:

add in interface java.util.List<T>

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<T>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<T>

listIterator

public java.util.ListIterator<T> listIterator()

Specified by:

listIterator in interface java.util.List<T>

listIterator

public java.util.ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface java.util.List<T>

subList

public java.util.List<T> subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface java.util.List<T>

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

getResults

public java.util.List<T> getResults()

Specified by:

getResults in interface PageResponse<T>

Returns:

the results

size

public int size()

Specified by:

size in interface PageResponse<T>

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<T>

Returns:

the number of results in this page of results

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.List<T>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.List<T>

hasMore

public boolean hasMore()

Description copied from interface: PageResponse

Indicates whether the source has more results after this page.

Specified by:

hasMore in interface PageResponse<T>

Returns:

true if there are more results