Package de.xima.fc.exceptions

Class NodeThrewException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.xima.fc.exceptions.AbstractXfcException

de.xima.fc.exceptions.WorkflowProcessingException

de.xima.fc.exceptions.AbstractAbruptCompletionException

de.xima.fc.exceptions.NodeThrewException

All Implemented Interfaces:

IXfcException, IBaseCompletionResult, IErrorResultData, IExceptionalCompletionResult, Serializable

public final class NodeThrewException
extends AbstractAbruptCompletionException
implements IExceptionalCompletionResult

Indicates that execution of a workflow node ended abruptly via a throw statement, including exceptions thrown by the workflow runtime engine.

Essentially, this is what you should use when you want to throw an exception that users can catch via try-catch node.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NodeThrewException.Builder	A simple builder for configuring a NodeThrewException.

Constructor Summary

Constructors

Constructor	Description
NodeThrewException(WorkflowNode node, Object alwaysValue, IDiscriminatedUnionMember<String,?> errorData, IWorkflowFileValue fileValue, String message)	Deprecated. Use builder(WorkflowNode).
NodeThrewException(WorkflowNode node, Object alwaysValue, IDiscriminatedUnionMember<String,?> errorData, IWorkflowFileValue fileValue, String message, Throwable cause)	Deprecated. Use builder(WorkflowNode).
NodeThrewException(WorkflowNode node, Object alwaysValue, IDiscriminatedUnionMember<String,?> errorData, IWorkflowFileValue fileValue, Throwable cause)	Deprecated. Use builder(WorkflowNode).

Method Summary

Modifier and Type	Method	Description
static NodeThrewException.Builder	builder(WorkflowNode node)
Object	getWorkflowExceptionData()
String	getWorkflowExceptionType()

Methods inherited from class de.xima.fc.exceptions.AbstractAbruptCompletionException

getAlwaysValue, getAttachmentValue, getFileValue, getNode

Methods inherited from class de.xima.fc.exceptions.WorkflowProcessingException

getDefaultErrorCode, getDefaultMessageKey

Methods inherited from class de.xima.fc.exceptions.AbstractXfcException

getErrorCode, getExceptionData, getLocalizedMessage, getMessageKey, getMessageParams

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IBaseCompletionResult

getAlwaysValue, getAttachmentValue, getFileValue, getNode

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IErrorResultData

getCause, getMessage

Constructor Details

NodeThrewException

@Deprecated
public NodeThrewException(WorkflowNode node,
 Object alwaysValue,
 IDiscriminatedUnionMember<String,?> errorData,
 IWorkflowFileValue fileValue,
 String message)

Deprecated.

Use builder(WorkflowNode). Ideally, do not create instances directly, prefer using INodeExecutionParams.throwingException().

Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Parameters:

node - Node that throws this exception.

alwaysValue - Data made available by the node irrespective of how it ends.

errorData - Data made available by the node when it ends abruptly by throwing an exception.

fileValue - List of files made available by the node.

message - Error message describing the error that occurred.

NodeThrewException

@Deprecated
public NodeThrewException(WorkflowNode node,
 Object alwaysValue,
 IDiscriminatedUnionMember<String,?> errorData,
 IWorkflowFileValue fileValue,
 String message,
 Throwable cause)

Deprecated.

Use builder(WorkflowNode). Ideally, do not create instances directly, prefer using INodeExecutionParams.throwingException().

Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Parameters:

node - Node that throws this exception.

alwaysValue - Data made available by the node irrespective of how it ends.

errorData - Data made available by the node when it ends abruptly by throwing an exception.

fileValue - List of files made available by the node.

message - Error message describing the error that occurred.

cause - Cause that resulted in this exception.

NodeThrewException

@Deprecated
public NodeThrewException(WorkflowNode node,
 Object alwaysValue,
 IDiscriminatedUnionMember<String,?> errorData,
 IWorkflowFileValue fileValue,
 Throwable cause)

Deprecated.

Use builder(WorkflowNode). Ideally, do not create instances directly, prefer using INodeExecutionParams.throwingException().

Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Parameters:

node - Node that throws this exception.

alwaysValue - Data made available by the node irrespective of how it ends.

errorData - Data made available by the node when it ends abruptly by throwing an exception.

fileValue - List of files made available by the node.

cause - Cause that resulted in this exception.

Method Details

getWorkflowExceptionData

public Object getWorkflowExceptionData()

Specified by:

getWorkflowExceptionData in interface IErrorResultData

Returns:

Custom data for the exception type that contain further details on the error. May be null in case no data is available.

getWorkflowExceptionType

public String getWorkflowExceptionType()

Specified by:

getWorkflowExceptionType in interface IErrorResultData

Returns:

Describes the type of error that occurred during the execution of a workflow node. Empty string for a general error that cannot be classified further.

builder

public static NodeThrewException.Builder builder(WorkflowNode node)

Parameters:

node - The node that did finish execution.

Returns:

A new builder for a NodeThrewException.

Since:

8.1.0