Package de.xima.fc.workflow.itemlist

Class FcForEachLoopItemListFiles

java.lang.Object

de.xima.fc.workflow.itemlist.FcForEachLoopItemListFiles

All Implemented Interfaces:

ItemList<IResolvedFile>, Iterable<IResolvedFile>

public final class FcForEachLoopItemListFiles
extends Object
implements ItemList<IResolvedFile>

Utility class for resolving an item list for the for-each loop of type EForEachLoopItemListSource.FILES.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
static ItemList<?>	evaluate(INodeExecutionParams<?> params, ListItemSourcePropsFiles sourceProps)	Resolves an item list for the for-each loop of type FILES.
ItemData	extractData(IResolvedFile item, int index)	Lazily extracts the additional required data for an item in this list.
Iterator<IResolvedFile>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

extractData

public ItemData extractData(IResolvedFile item,
                            int index)

Description copied from interface: ItemList

Lazily extracts the additional required data for an item in this list.

Specified by:

extractData in interface ItemList<IResolvedFile>

Parameters:

item - An item as returned by Iterable.iterator().

index - 0-based index of the item returned by Iterable.iterator().

Returns:

The extracted item data for the given item of this list.

iterator

public Iterator<IResolvedFile> iterator()

Specified by:

iterator in interface Iterable<IResolvedFile>

evaluate

public static ItemList<?> evaluate(INodeExecutionParams<?> params,
                                   ListItemSourcePropsFiles sourceProps)
                            throws NodeThrewException

Resolves an item list for the for-each loop of type FILES.

Parameters:

params - Workflow node execution params for the for each loop node.

sourceProps - Configured properties.

Returns:

An item list with all resolved file items.

Throws:

NodeThrewException - When the referenced files could not be resolved.