org.nuxeo.ecm.core.api.impl

Class DocumentModelListImpl

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<DocumentModel>

org.nuxeo.ecm.core.api.impl.DocumentModelListImpl

All Implemented Interfaces:

Serializable, Cloneable, Iterable<DocumentModel>, Collection<DocumentModel>, List<DocumentModel>, RandomAccess, DocumentModelList

Direct Known Subclasses:

PaginableDocumentModelListImpl

public class DocumentModelListImpl
extends ArrayList<DocumentModel>
implements DocumentModelList

Author:

Bogdan Stefanescu, Florent Guillaume

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentModelListImpl()
DocumentModelListImpl(int size)
DocumentModelListImpl(List<DocumentModel> list)
DocumentModelListImpl(List<DocumentModel> list, long totalSize) Constructs a DocumentModelListImpl and sets the "total size" information.

Method Summary

Methods

Modifier and Type	Method and Description
void	setTotalSize(long totalSize)
long	totalSize() Returns the total size of the bigger list this is a part of.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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, retainAll, set, size, subList, toArray, toArray

Constructor Detail

DocumentModelListImpl

public DocumentModelListImpl()

DocumentModelListImpl

public DocumentModelListImpl(int size)

DocumentModelListImpl

public DocumentModelListImpl(List<DocumentModel> list)

DocumentModelListImpl

public DocumentModelListImpl(List<DocumentModel> list,
                     long totalSize)

Constructs a DocumentModelListImpl and sets the "total size" information.

The total size is additional information that can be provided in some cases where the list returned is a slice of a bigger list, this is used when getting paged results from a database for instance.

Parameters:

list - the list of documents

totalSize - the total size, with -1 meaning "same as the list's size"

Method Detail

setTotalSize

public void setTotalSize(long totalSize)

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