org.nuxeo.ecm.core.api.impl
Class DocumentRefListImpl

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.ArrayList<DocumentRef>
              org.nuxeo.ecm.core.api.impl.DocumentRefListImpl

All Implemented Interfaces:

Serializable, Cloneable, Iterable<DocumentRef>, Collection<DocumentRef>, List<DocumentRef>, RandomAccess, DocumentRefList

public class DocumentRefListImpl
extends ArrayList<DocumentRef>
implements DocumentRefList

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Constructor Summary

DocumentRefListImpl()

DocumentRefListImpl(int size)

DocumentRefListImpl(List<DocumentRef> list)

DocumentRefListImpl(List<DocumentRef> list, long totalSize)
Constructs a DocumentModelListImpl and sets the "total size" information.

Method Summary

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, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode, iterator, listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, removeAll, retainAll, 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

DocumentRefListImpl

public DocumentRefListImpl()

DocumentRefListImpl

public DocumentRefListImpl(int size)

DocumentRefListImpl

public DocumentRefListImpl(List<DocumentRef> list)

DocumentRefListImpl

public DocumentRefListImpl(List<DocumentRef> 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: DocumentRefList

Returns the total size of the bigger list this is a part of.

Specified by:

totalSize in interface DocumentRefList

Returns:

the total size