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

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.ArrayList<DocumentRef>
              org.nuxeo.ecm.automation.core.collectors.DocumentRefCollector

All Implemented Interfaces:

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

public class DocumentRefCollector
extends ArrayList<DocumentRef>
implements DocumentRefList, OutputCollector<DocumentRef,DocumentRefList>

This implementation collect DocumentRef objects and return them as a DocumentRefList object.

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

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Constructor Summary

DocumentRefCollector()

Method Summary

void	collect(OperationContext ctx, DocumentRef ref) Collects a new partial result (the result of the last iteration step).
DocumentRefList	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

DocumentRefCollector

public DocumentRefCollector()

Method Detail

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

collect

public void collect(OperationContext ctx,
                    DocumentRef ref)
             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<DocumentRef,DocumentRefList>

Throws:

OperationException

getOutput

public DocumentRefList 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<DocumentRef,DocumentRefList>