Package com.blazebit.persistence

Class PagedArrayList<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

com.blazebit.persistence.PagedArrayList<T>

Type Parameters:

T - the type of elements in this list

All Implemented Interfaces:

PagedList<T>, Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess

public class PagedArrayList<T>
extends ArrayList<T>
implements PagedList<T>

A simple implementation of PagedList based on ArrayList.

Since:

1.2.0

Author:

Christian Beikov, Moritz Becker

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface com.blazebit.persistence.PagedList

EMPTY

Constructor Summary

Constructors

Constructor	Description
PagedArrayList(KeysetPage keyset, long totalSize, int firstResult, int maxResults)	Constructs a new empty paged array list.
PagedArrayList(Collection<? extends T> collection, KeysetPage keyset, long totalSize, int firstResult, int maxResults)	Constructs a new paged array list from the given collection.

Method Summary

Modifier and Type	Method	Description
int	getFirstResult()	Returns the position of the first result, numbered from 0.
KeysetPage	getKeysetPage()	Returns the key set page for this paged list which can be used for key set pagination.
int	getMaxResults()	Returns the maximum number of results.
int	getPage()	Returns the number of this page, numbered from 1.
int	getSize()	Returns the actual size of this page.
int	getTotalPages()	Returns the number of total pages.
long	getTotalSize()	Returns the total size of the list or -1 if the count query was disabled via PaginatedCriteriaBuilder.withCountQuery(boolean).

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Constructor Detail

PagedArrayList

public PagedArrayList(KeysetPage keyset,
                      long totalSize,
                      int firstResult,
                      int maxResults)

Constructs a new empty paged array list.

Parameters:

keyset - The keyset page for this page

totalSize - The total size of the result

firstResult - The first result index within the overall result

maxResults - The maximum result count for a page

PagedArrayList

public PagedArrayList(Collection<? extends T> collection,
                      KeysetPage keyset,
                      long totalSize,
                      int firstResult,
                      int maxResults)

Constructs a new paged array list from the given collection.

Parameters:

collection - The collection of elements for this page

keyset - The keyset page for this page

totalSize - The total size of the result

firstResult - The first result index within the overall result

maxResults - The maximum result count for a page

Method Detail

getSize

public int getSize()

Description copied from interface: PagedList

Returns the actual size of this page.

Specified by:

getSize in interface PagedList<T>

Returns:

The actual size

See Also:

List.size()

getTotalSize

public long getTotalSize()

Description copied from interface: PagedList

Returns the total size of the list or -1 if the count query was disabled via PaginatedCriteriaBuilder.withCountQuery(boolean).

Specified by:

getTotalSize in interface PagedList<T>

Returns:

The total size or -1 if the count query was disabled

getPage

public int getPage()

Description copied from interface: PagedList

Returns the number of this page, numbered from 1.

Specified by:

getPage in interface PagedList<T>

Returns:

The number of this page

getTotalPages

public int getTotalPages()

Description copied from interface: PagedList

Returns the number of total pages.

Specified by:

getTotalPages in interface PagedList<T>

Returns:

The number of total pages

getFirstResult

public int getFirstResult()

Description copied from interface: PagedList

Returns the position of the first result, numbered from 0. This is the position which was actually queried. This value might be different from KeysetPage.getFirstResult(). If this list was queried with an entity id which does not exist, this will return -1;

Specified by:

getFirstResult in interface PagedList<T>

Returns:

The position of the first result or -1 if the queried entity id does not exist

getMaxResults

public int getMaxResults()

Description copied from interface: PagedList

Returns the maximum number of results. This is the maximum number which was actually queried. This value might be different from KeysetPage.getFirstResult().

Specified by:

getMaxResults in interface PagedList<T>

Returns:

The maximum number of results

getKeysetPage

public KeysetPage getKeysetPage()

Description copied from interface: PagedList

Returns the key set page for this paged list which can be used for key set pagination. The key set page may be null if key set pagination wasn't used.

Specified by:

getKeysetPage in interface PagedList<T>

Returns:

The key set

See Also:

FullQueryBuilder.page(com.blazebit.persistence.KeysetPage, int, int)