PagedResultList (GORM for MongoDB

grails.gorm.PagedResultList

All Implemented Interfaces and Traits:

java.io.Serializable, java.util.List
```
@java.lang.SuppressWarnings({"rawtypes", "unchecked"})
public class PagedResultList<E>
extends java.lang.Object
implements java.io.Serializable, java.util.List
```
A result list implementation that provides an additional property called 'totalCount' to obtain the total number of records. Useful for pagination.
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`private Query`	`query`
`protected java.util.List<E>`	`resultList`
`private static long`	`serialVersionUID`
`protected int`	`totalCount`

Constructor Summary

Constructors
Constructor and description
`PagedResultList (Query query)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`add(int i, E o)`
	`public boolean`	`add(E e)`
	`public boolean`	`addAll(java.util.Collection<? extends E> c)`
	`public boolean`	`addAll(int index, java.util.Collection<? extends E> c)`
	`public void`	`clear()`
	`public boolean`	`contains(java.lang.Object o)`
	`public boolean`	`containsAll(java.util.Collection<?> c)`
	`public boolean`	`equals(java.lang.Object o)`
	`public E`	`get(int i)`
	`public int`	`getTotalCount()` Returns: The total number of records for this query
	`public int`	`hashCode()`
	`public int`	`indexOf(java.lang.Object o)`
	`protected void`	`initialize()`
	`public boolean`	`isEmpty()`
	`public java.util.Iterator<E>`	`iterator()`
	`public int`	`lastIndexOf(java.lang.Object o)`
	`public java.util.ListIterator<E>`	`listIterator()`
	`public java.util.ListIterator<E>`	`listIterator(int index)`
	`public E`	`remove(int i)`
	`public boolean`	`remove(java.lang.Object o)`
	`public boolean`	`removeAll(java.util.Collection<?> c)`
	`public boolean`	`retainAll(java.util.Collection<?> c)`
	`public E`	`set(int i, E o)`
	`public int`	`size()`
	`public java.util.List<E>`	`subList(int fromIndex, int toIndex)`
	`public java.lang.Object[]`	`toArray()`
`<T>`	`public T[]`	`toArray(T[] a)`
	`private void`	`writeObject(java.io.ObjectOutputStream out)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private final Query query
  - protected java.util.List<E> resultList
  - private static final long serialVersionUID
  - protected int totalCount
- Constructor Detail
  - public PagedResultList(Query query)
- Method Detail
  - @java.lang.Override public void add(int i, E o)
  - @java.lang.Override public boolean add(E e)
  - @java.lang.Override public boolean addAll(java.util.Collection<? extends E> c)
  - @java.lang.Override public boolean addAll(int index, java.util.Collection<? extends E> c)
  - @java.lang.Override public void clear()
  - @java.lang.Override public boolean contains(java.lang.Object o)
  - @java.lang.Override public boolean containsAll(java.util.Collection<?> c)
  - @java.lang.Override public boolean equals(java.lang.Object o)
  - @java.lang.Override public E get(int i)
  - public int getTotalCount()
    
    Returns:
    The total number of records for this query
  - @java.lang.Override public int hashCode()
  - @java.lang.Override public int indexOf(java.lang.Object o)
  - protected void initialize()
  - @java.lang.Override public boolean isEmpty()
  - @java.lang.Override public java.util.Iterator<E> iterator()
  - @java.lang.Override public int lastIndexOf(java.lang.Object o)
  - @java.lang.Override public java.util.ListIterator<E> listIterator()
  - @java.lang.Override public java.util.ListIterator<E> listIterator(int index)
  - @java.lang.Override public E remove(int i)
  - @java.lang.Override public boolean remove(java.lang.Object o)
  - @java.lang.Override public boolean removeAll(java.util.Collection<?> c)
  - @java.lang.Override public boolean retainAll(java.util.Collection<?> c)
  - @java.lang.Override public E set(int i, E o)
  - @java.lang.Override public int size()
  - @java.lang.Override public java.util.List<E> subList(int fromIndex, int toIndex)
  - @java.lang.Override public java.lang.Object[] toArray()
  - <T> @java.lang.Override public T[] toArray(T[] a)
  - private void writeObject(java.io.ObjectOutputStream out)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class PagedResultList<E>

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private final Query query

protected java.util.List<E> resultList

private static final long serialVersionUID

protected int totalCount

Constructor Detail

public PagedResultList(Query query)

Method Detail

@java.lang.Override public void add(int i, E o)

@java.lang.Override public boolean add(E e)

@java.lang.Override public boolean addAll(java.util.Collection<? extends E> c)

@java.lang.Override public boolean addAll(int index, java.util.Collection<? extends E> c)

@java.lang.Override public void clear()

@java.lang.Override public boolean contains(java.lang.Object o)

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

@java.lang.Override public boolean equals(java.lang.Object o)

@java.lang.Override public E get(int i)

public int getTotalCount()

@java.lang.Override public int hashCode()

@java.lang.Override public int indexOf(java.lang.Object o)

protected void initialize()

@java.lang.Override public boolean isEmpty()

@java.lang.Override public java.util.Iterator<E> iterator()

@java.lang.Override public int lastIndexOf(java.lang.Object o)

@java.lang.Override public java.util.ListIterator<E> listIterator()

@java.lang.Override public java.util.ListIterator<E> listIterator(int index)

@java.lang.Override public E remove(int i)

@java.lang.Override public boolean remove(java.lang.Object o)

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

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

@java.lang.Override public E set(int i, E o)

@java.lang.Override public int size()

@java.lang.Override public java.util.List<E> subList(int fromIndex, int toIndex)

@java.lang.Override public java.lang.Object[] toArray()

<T> @java.lang.Override public T[] toArray(T[] a)

private void writeObject(java.io.ObjectOutputStream out)