PaginableDocumentModelListImpl (Nuxeo 2021.53.3 API Documentation)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.ArrayList<T>
    - - org.nuxeo.ecm.automation.core.util.PaginablePageProvider<DocumentModel>
      - org.nuxeo.ecm.automation.jaxrs.io.documents.PaginableDocumentModelListImpl

All Implemented Interfaces:

Serializable, Cloneable, Iterable<DocumentModel>, Collection<DocumentModel>, List<DocumentModel>, RandomAccess, Paginable<DocumentModel>, PaginableDocumentModelList, DocumentModelList
```
public class PaginableDocumentModelListImpl
extends PaginablePageProvider<DocumentModel>
implements PaginableDocumentModelList
```
Wraps a PageProvider as a DocumentModelList

Author:

Tiry ([email protected])

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String documentLinkBuilder
- Fields inherited from class org.nuxeo.ecm.automation.core.util.PaginablePageProvider
  pageProvider
- Fields inherited from class java.util.AbstractList
  modCount
- Fields inherited from interface org.nuxeo.ecm.automation.core.util.PaginableDocumentModelList
  CODEC_PARAMETER_NAME

Constructor Summary

Constructors
Constructor	Description
`PaginableDocumentModelListImpl(PageProvider<DocumentModel> provider)`
`PaginableDocumentModelListImpl(PageProvider<DocumentModel> provider, String documentLinkBuilder)`	Creates a `PaginableDocumentModelListImpl` with more display information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDocumentLinkBuilder()`	Returns the name of what will be used to compute the document URLs, usually a codec name.
`PageProvider<DocumentModel>`	`getProvider()`
`long`	`totalSize()`	Returns the total size of the bigger list this is a part of.

Methods inherited from class org.nuxeo.ecm.automation.core.util.PaginablePageProvider
getActiveQuickFilters, getAggregates, getAvailableQuickFilters, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getErrorMessage, getMaxPageSize, getNumberOfPages, getPageSize, getResultsCount, getResultsCountLimit, hasAggregateSupport, hasError, isLastPageAvailable, isNextPageAvailable, isPreviousPageAvailable, isSortable

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, toString

Methods inherited from class java.lang.Object
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
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface org.nuxeo.ecm.automation.core.util.Paginable
getActiveQuickFilters, getAggregates, getAvailableQuickFilters, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getErrorMessage, getMaxPageSize, getNumberOfPages, getPageSize, getResultsCount, getResultsCountLimit, hasAggregateSupport, hasError, isLastPageAvailable, isNextPageAvailable, isPreviousPageAvailable, isSortable

- Field Detail
  - documentLinkBuilder
```
protected String documentLinkBuilder
```
- Constructor Detail
  - PaginableDocumentModelListImpl
```
public PaginableDocumentModelListImpl(PageProvider<DocumentModel> provider)
```
  - PaginableDocumentModelListImpl
```
public PaginableDocumentModelListImpl(PageProvider<DocumentModel> provider,
                                      String documentLinkBuilder)
```
    Creates a PaginableDocumentModelListImpl with more display information.
    
    Parameters:
    
    documentLinkBuilder - the name of what will be used to compute the document URLs, usually a codec name.
    
    Since:
    
    5.6
- Method Detail
  - getProvider
```
public PageProvider<DocumentModel> getProvider()
```
  - getDocumentLinkBuilder
```
public String getDocumentLinkBuilder()
```
    Description copied from interface: PaginableDocumentModelList
    
    Returns the name of what will be used to compute the document URLs, usually a codec name.
    
    Specified by:
    
    getDocumentLinkBuilder in interface PaginableDocumentModelList
  - totalSize
```
public long totalSize()
```
    Description copied from interface: DocumentModelList
    
    Returns the total size of the bigger list this is a part of.
    
    Specified by:
    
    totalSize in interface DocumentModelList
    
    Returns:
    
    the total size