Package net.swofty.utility

Class PaginationList<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

net.swofty.utility.PaginationList<T>

Type Parameters:

T - Type of the ArrayList

All Implemented Interfaces:

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

public class PaginationList<T>
extends ArrayList<T>

A page-based ArrayList * Pages are NOT index-based (they start at 1, not 0) * A page sublist is created when you call a method to get one; it is not created and then updated accordingly.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
PaginationList(int elementsPerPage)	Defines a new Pagination List.
PaginationList(int elementsPerPage, T... elements)	Defines a new Pagination List.
PaginationList(Collection<T> collection, int elementsPerPage)

Method Summary

Modifier and Type	Method	Description
PaginationList<T>	addAll(T[] t)
int	getElementsPerPage()
List<T>	getPage(int page)	Get a page from the list.
int	getPageCount()
List<List<T>>	getPages()
void	setElementsPerPage(int elementsPerPage)	Sets the element count per page.
String	toString()

Methods inherited from class java.util.ArrayList

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

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

PaginationList

public PaginationList(Collection<T> collection,
 int elementsPerPage)

PaginationList

public PaginationList(int elementsPerPage)

Defines a new Pagination List.

Parameters:

elementsPerPage - How many elements will be included on a page of the list.

PaginationList

public PaginationList(int elementsPerPage,
 T... elements)

Defines a new Pagination List.

Parameters:

elementsPerPage - How many elements will be included on a page of the list.

elements - Elements to add to the list immediately.

Method Details

getElementsPerPage

public int getElementsPerPage()

Returns:

The amount of elements per page.

setElementsPerPage

public void setElementsPerPage(int elementsPerPage)

Sets the element count per page.

Parameters:

elementsPerPage - Updated element count per page

getPageCount

public int getPageCount()

Returns:

The number of pages this list holds.

getPage

public List<T> getPage(int page)

Get a page from the list.

Parameters:

page - Page you want to access.

Returns:

A sublist of only the elements from that page.

getPages

public List<List<T>> getPages()

Returns:

A 2D List with every page.

addAll

public PaginationList<T> addAll(T[] t)

toString

public String toString()

Overrides:

toString in class AbstractCollection<T>