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 collectDocumentRef
objects and return them as aDocumentRefList
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
-
-
Field Summary
-
Fields inherited from class java.util.AbstractList
modCount
-
-
Constructor Summary
Constructors Constructor Description DocumentRefCollector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, 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.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
-
-
-
-
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 interfaceDocumentRefList
- 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 interfaceOutputCollector<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 interfaceOutputCollector<DocumentRef,DocumentRefList>
-
-