Package de.xima.fc.interfaces.workflow.params

Interface INodeReturnedExceptionBuilder

  • All Superinterfaces:
    org.apache.commons.lang3.builder.Builder<NodeReturnedException>
    public interface INodeReturnedExceptionBuilder
extends org.apache.commons.lang3.builder.Builder<NodeReturnedException>
    Builder for the exception thrown by a node when it wishes to stop the current execution by issuing a return statement. When no value is supplied, the defaults of the value descriptor are used.
    Since:
    7.0.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • always

        INodeReturnedExceptionBuilder always​(IValueCreator<?> alwaysValue)
        Sets (replaces) the value made available by the node regardless of whether it was executed successfully (or threw an exception). When this method is not called, the default value from the IExecutionResultDescriptor.getAlwaysValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.

        For example, when you wish to return a record with two properties: 

         // Corresponds to the JSON object {"foo": "bar", "baz": 42}
 builder.success(b -> b.asRecord().property("foo", "bar").property("baz", 42);
        Parameters:
        alwaysValue - Function that takes a value builder to create the value.
        Returns:
        this for chaining.

      • always

        default INodeReturnedExceptionBuilder always​(Object alwaysValue)
        Sets (replaces) the value made available by the node regardless of whether it was executed successfully (or threw an exception). When this method is not called, the default value from the IExecutionResultDescriptor.getAlwaysValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.
        Parameters:
        alwaysValue - Value made available by the plugin when it was executed.
        Returns:
        this for chaining.

      • cause

        INodeReturnedExceptionBuilder cause​(Throwable cause)
        Parameters:
        cause - The cause that resulted in the returning exception. Since a return is usually intended, you should not have to call this method in most cases.
        Returns:
        this for chaining.

      • file

        default INodeReturnedExceptionBuilder file​(File... files)
        Sets (replaces) the files made available by the plugin when it was executed successfully. When this method is not called, the default value from the IExecutionResultDescriptor.getFileValueDescriptor() is used. When this method is called multiple times, only the value supplied by the last invocation is used.
        Parameters:
        files - File or files supplied by the plugin.
        Returns:
        this for chaining.

      • file

        default INodeReturnedExceptionBuilder file​(Iterable<File> files)
        Sets (replaces) the files made available by the plugin when it was executed successfully. When this method is not called, the default value from the IExecutionResultDescriptor.getFileValueDescriptor() is used. When this method is called multiple times, only the value supplied by the last invocation is used.
        Parameters:
        files - File or files supplied by the plugin.
        Returns:
        this for chaining.

      • message

        INodeReturnedExceptionBuilder message​(String message)
        Parameters:
        message - The cause that resulted in the returning exception. Since a return is usually intended, you should not have to call this method in most cases.
        Returns:
        this for chaining.

      • success

        INodeReturnedExceptionBuilder success​(IValueCreator<?> successValue)
        Sets (replaces) the value returned by the node when it was executed successfully. This value is ignored unless the node was actually executed successfully. When this method is not called, the default value from the IExecutionResultDescriptor.getSuccessValueDescriptor(de.xima.fc.interfaces.workflow.value.IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.

        For example, when you wish to return a record with two properties: 

         // Corresponds to the JSON object {"foo": "bar", "baz": 42}
 builder.success(b -> b.asRecord().property("foo", "bar").property("baz", 42);
        Parameters:
        successValue - Function that takes a value builder to create the value.
        Returns:
        this for chaining.

      • success

        default INodeReturnedExceptionBuilder success​(Object successValue)
        Sets (replaces) the value returned by the node when it was executed successfully. This value is ignored unless the node was actually executed successfully. When this method is not called, the default value from the IExecutionResultDescriptor.getSuccessValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.
        Parameters:
        successValue - Value made available by the plugin when it was executed successfully.
        Returns:
        this for chaining.