Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.automation.core.collectors
Class DocumentModelCollector

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList<DocumentModel>
              extended by org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector
All Implemented Interfaces:
Serializable, Cloneable, Iterable<DocumentModel>, Collection<DocumentModel>, List<DocumentModel>, RandomAccess, OutputCollector<DocumentModel,DocumentModelList>, DocumentModelList

public class DocumentModelCollector
extends ArrayList<DocumentModel>
implements DocumentModelList, OutputCollector<DocumentModel,DocumentModelList>

This implementation collect DocumentModel objects and return them as a DocumentModelList object.

You may use this to automatically iterate over iterable inputs in operation methods that return a DocumentModel object

Author:
Bogdan Stefanescu
See Also:
Serialized Form

Constructor Summary
DocumentModelCollector()
           
 
Method Summary
 void collect(OperationContext ctx, DocumentModel obj)
          Collects a new partial result (the result of the last iteration step).
 DocumentModelList getOutput()
          Gets the final output.
 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

DocumentModelCollector

public DocumentModelCollector()
Method Detail

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

collect

public void collect(OperationContext ctx,
                    DocumentModel obj)
             throws OperationException
Description copied from interface: OutputCollector
Collects a new partial result (the result of the last iteration step).

Specified by:
collect in interface OutputCollector<DocumentModel,DocumentModelList>
Throws:
OperationException

getOutput

public DocumentModelList getOutput()
Description copied from interface: OutputCollector
Gets the final output. This is usually a list or set of collected objects.

Specified by:
getOutput in interface OutputCollector<DocumentModel,DocumentModelList>

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.