Package com.atlassian.confluence.rest.v2.api.model

Class RestList<T>

java.lang.Object

com.atlassian.confluence.rest.v2.api.model.RestObject

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

Type Parameters:

T -

All Implemented Interfaces:

PageResponse<T>, NavigationAware, Iterable<T>, Collection<T>, List<T>, SequencedCollection<T>

@ExperimentalApi
public final class RestList<T>
extends RestObject
implements PageResponse<T>, List<T>, NavigationAware

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

Since:

9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestList.Builder<T>

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

RestObject.Properties

Field Summary

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

jsonProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestList()

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
boolean	add(T o)
boolean	addAll(int index, Collection<? extends T> c)
boolean	addAll(Collection<? extends T> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
static <T> RestList<T>	createRestList(PageRequest pageRequest, PageResponse<T> pageResponse)	Deprecated. since 5.6.5.
static <T> RestList<T>	createRestList(PageRequest request, List<T> results, boolean hasMore)	Deprecated. since 5.6.5.
static <T> RestList<T>	createRestList(PageResponse<T> pageResponse)	Deprecated. since 5.6.5.
boolean	equals(Object obj)
T	get(int index)
Cursor	getNextCursor()
PageRequest	getPageRequest()
PageResponse<T>	getPageResponse()
Cursor	getPrevCursor()
List<T>	getResults()
int	hashCode()
boolean	hasMore()	Indicates whether the source has more results after this page.
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
static <T> RestList.Builder<T>	newRestList()
static <T> RestList.Builder<T>	newRestList(PageRequest pageRequest)
static <T> RestList.Builder<T>	newRestList(PageResponse<T> response)
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
Navigation.Builder	resolveNavigation(NavigationService navigationService)
boolean	retainAll(Collection<?> c)
T	set(int index, T element)
int	size()
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<A> A[]	toArray(A[] a)
String	toString()

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

getProperty, hasProperty, properties, putProperties, putProperty, removeProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface com.atlassian.confluence.api.model.pagination.PageResponse

getTotalCount

Constructor Details

RestList

protected RestList()

Method Details

newRestList

public static <T> RestList.Builder<T> newRestList(PageRequest pageRequest)

newRestList

public static <T> RestList.Builder<T> newRestList(PageResponse<T> response)

newRestList

public static <T> RestList.Builder<T> newRestList()

createRestList

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

Deprecated.

since 5.6.5. Use newRestList(PageResponse) instead.

createRestList

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

Deprecated.

since 5.6.5. Use newRestList(PageResponse) instead.

createRestList

@Deprecated
public static <T> RestList<T> createRestList(PageRequest request,
 List<T> results,
 boolean hasMore)

Deprecated.

since 5.6.5. Use newRestList(PageRequest) instead.

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 String toString()

Overrides:

toString in class Object

resolveNavigation

public Navigation.Builder resolveNavigation(NavigationService navigationService)

Specified by:

resolveNavigation in interface NavigationAware

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface List<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

add

public boolean add(T o)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

addAll

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

Specified by:

addAll in interface List<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

get

public T get(int index)

Specified by:

get in interface List<T>

set

public T set(int index,
 T element)

Specified by:

set in interface List<T>

add

public void add(int index,
 T element)

Specified by:

add in interface List<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

subList

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

Specified by:

subList in interface List<T>

toArray

public <A> A[] toArray(A[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

getResults

public List<T> getResults()

Specified by:

getResults in interface PageResponse<T>

Returns:

the results

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

Specified by:

size in interface PageResponse<T>

Returns:

the number of results in this page of results

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface 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

getNextCursor

public Cursor getNextCursor()

Specified by:

getNextCursor in interface PageResponse<T>

Returns:

the identifier which is used to skip results from a previous query when paginating in forward direction.

getPrevCursor

public Cursor getPrevCursor()

Specified by:

getPrevCursor in interface PageResponse<T>

Returns:

the identifier which is used to skip results from a previous query when paginating in backward direction.

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Overrides:

hashCode in class Object