Package de.xima.fc.workflow

Class FileValueDescriptor.Builder

java.lang.Object

de.xima.fc.workflow.FileValueDescriptor.Builder

Enclosing class:

FileValueDescriptor

public static final class FileValueDescriptor.Builder
extends Object

Builder for a file value descriptor.

Since:

8.2.0

Method Summary

Modifier and Type	Method	Description
IFileValueDescriptor	build()	Builds a new file value descriptor with the data that was added to this builder.
FileValueDescriptor.Builder	fileList(IFileListDescriptor fileList)	Adds a file list to this builder, for the default type of file.
FileValueDescriptor.Builder	fileList(String fileKey, IFileListDescriptor fileList)	Adds a file list to this builder, for the given type of file.
FileValueDescriptor.Builder	fileList(String fileKey, Consumer<? super FileListDescriptor.Builder> configurator)	Adds a file list descriptor to this builder, for the given type of file.
FileValueDescriptor.Builder	fileList(Consumer<? super FileListDescriptor.Builder> configurator)	Adds a file list descriptor to this builder, for the default type of file.
FileValueDescriptor.Builder	fileList(Map<String,IFileListDescriptor> fileList)	Adds the given map of file lists to this builder.

Methods inherited from class java.lang.Object

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

Method Detail

build

public IFileValueDescriptor build()

Builds a new file value descriptor with the data that was added to this builder. Any modifications to this builder after calling this method will not affect the returned file value descriptor.

Returns:

A new file value descriptor with the data that was added to this builder.

fileList

public FileValueDescriptor.Builder fileList(Map<String,IFileListDescriptor> fileList)

Adds the given map of file lists to this builder.

Parameters:

fileList - The map of file lists to add.

Returns:

This builder for chaining method calls.

fileList

public FileValueDescriptor.Builder fileList(Consumer<? super FileListDescriptor.Builder> configurator)

Adds a file list descriptor to this builder, for the default type of file.

Parameters:

configurator - The configurator for a new file list descriptor.

Returns:

This builder for chaining method calls.

fileList

public FileValueDescriptor.Builder fileList(String fileKey,
                                            Consumer<? super FileListDescriptor.Builder> configurator)

Adds a file list descriptor to this builder, for the given type of file.

Parameters:

fileKey - The technical name for the type of files.

configurator - The configurator for a new file list descriptor.

Returns:

This builder for chaining method calls.

fileList

public FileValueDescriptor.Builder fileList(String fileKey,
                                            IFileListDescriptor fileList)

Adds a file list to this builder, for the given type of file.

Parameters:

fileKey - The technical name for the type of files.

fileList - Descriptor for the list of files.

Returns:

This builder for chaining method calls.

fileList

public FileValueDescriptor.Builder fileList(IFileListDescriptor fileList)

Adds a file list to this builder, for the default type of file.

Parameters:

fileList - Descriptor for the list of files.

Returns:

This builder for chaining method calls.