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
Author:
XIMA MEDIA GmbH

  • Method Details

    • addAttribute

      public FileValueDescriptor.Builder addAttribute(String name, Object value)
      Adds an attribute to the file list descriptor. If value is null, the attribute is removed.

      See StandardValueDescriptorAttributes for some standard attribute keys and values you can use.

      Parameters:
      name - The name of the attribute.
      value - The value of the attribute.
      Returns:
      This builder for chaining method calls.
      See Also:

    • addAttributes

      public FileValueDescriptor.Builder addAttributes(Map<String,Object> attributes)
      Adds all attributes from the given map to the file list descriptor. If attributes is null, nothing is added.

      See StandardValueDescriptorAttributes for some standard attribute keys and values you can use.

      Parameters:
      attributes - The attributes to add.
      Returns:
      This builder for chaining method calls.
      See Also:

    • additionalFileLists

      public FileValueDescriptor.Builder additionalFileLists(IFileListDescriptor fileList)
      Sets the descriptor for any additional files that may be provided by the workflow element, under keys not defined explicitly via fileList(Map). When not set, no additional files are allowed.
      Parameters:
      fileList - The descriptor for any additional files that may be provided by the workflow element.
      Returns:
      This builder for chaining method calls.
      Since:
      8.5.0

    • additionalFileLists

      public FileValueDescriptor.Builder additionalFileLists(Consumer<? super FileListDescriptor.Builder> configurator)
      Sets the descriptor for any additional files that may be provided by the workflow element, under keys not defined explicitly via fileList(Map). When not set, no additional files are allowed.
      Parameters:
      configurator - The configurator for the descriptor for any additional files that may be provided by the workflow element.
      Returns:
      This builder for chaining method calls.
      Since:
      8.5.0

    • attributes

      public FileValueDescriptor.Builder attributes(Map<String,Object> attributes)
      Sets (replaces) all attributes of the file list descriptor. If attributes is null, all attributes are removed.

      See StandardValueDescriptorAttributes for some standard attribute keys and values you can use.

      Parameters:
      attributes - The new attributes to set.
      Returns:
      This builder for chaining method calls.
      See Also:

    • 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(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(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(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.