Package io.camunda.zeebe.model.bpmn.builder

Class AbstractThrowEventBuilder<B extends AbstractThrowEventBuilder<B,E>,E extends ThrowEvent>

java.lang.Object

io.camunda.zeebe.model.bpmn.builder.AbstractBpmnModelElementBuilder<B,E>

io.camunda.zeebe.model.bpmn.builder.AbstractBaseElementBuilder<B,E>

io.camunda.zeebe.model.bpmn.builder.AbstractFlowElementBuilder<B,E>

io.camunda.zeebe.model.bpmn.builder.AbstractFlowNodeBuilder<B,E>

io.camunda.zeebe.model.bpmn.builder.AbstractEventBuilder<B,E>

io.camunda.zeebe.model.bpmn.builder.AbstractThrowEventBuilder<B,E>

All Implemented Interfaces:

ZeebeJobWorkerElementBuilder<B>, ZeebeJobWorkerPropertiesBuilder<B>, ZeebeVariablesMappingBuilder<B>

Direct Known Subclasses:

AbstractEndEventBuilder, AbstractIntermediateThrowEventBuilder

public abstract class AbstractThrowEventBuilder<B extends AbstractThrowEventBuilder<B,E>,E extends ThrowEvent>
extends AbstractEventBuilder<B,E>
implements ZeebeJobWorkerElementBuilder<B>

Author:

Sebastian Menski

Field Summary

Fields inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractFlowNodeBuilder

compensateBoundaryEvent, compensationStarted

Fields inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBaseElementBuilder

SPACE, ZEEBE_EXPRESSION_FORMAT

Fields inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBpmnModelElementBuilder

element, modelInstance, myself

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractThrowEventBuilder(BpmnModelInstance modelInstance, E element, Class<?> selfType)

Method Summary

Modifier and Type	Method	Description
CompensateEventDefinitionBuilder	compensateEventDefinition()
CompensateEventDefinitionBuilder	compensateEventDefinition(String id)
B	escalation(String escalationCode)	Sets an escalation definition for the given escalation code.
B	message(String messageName)	Sets an event definition for the given message name.
MessageEventDefinitionBuilder	messageEventDefinition()	Creates an empty message event definition with an unique id and returns a builder for the message event definition.
MessageEventDefinitionBuilder	messageEventDefinition(String id)	Creates an empty message event definition with the given id and returns a builder for the message event definition.
B	signal(String signalName)	Sets an event definition for the given signal name.
SignalEventDefinitionBuilder	signalEventDefinition(String signalName)	Sets an event definition for the given Signal name.
B	zeebeInput(String source, String target)
B	zeebeInputExpression(String sourceExpression, String target)
B	zeebeJobRetries(String retries)	Sets a static number of retries for the job.
B	zeebeJobRetriesExpression(String expression)	Sets a dynamic number of retries for the job that is retrieved from the given expression
B	zeebeJobType(String type)	Sets a static type for the job.
B	zeebeJobTypeExpression(String expression)	Sets a dynamic type for the job that is retrieved from the given expression.
B	zeebeOutput(String source, String target)
B	zeebeOutputExpression(String sourceExpression, String target)
B	zeebeTaskHeader(String key, String value)	Adds a custom task header for the job.

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractFlowNodeBuilder

businessRuleTask, businessRuleTask, businessRuleTask, callActivity, callActivity, callActivity, compensationDone, compensationStart, condition, condition, conditionExpression, connectTarget, connectTargetWithAssociation, connectTargetWithSequenceFlow, connectTo, createTarget, createTargetBuilder, createTargetBuilder, endEvent, endEvent, endEvent, eventBasedGateway, eventBasedGateway, exclusiveGateway, exclusiveGateway, getCurrentSequenceFlowBuilder, inclusiveGateway, inclusiveGateway, intermediateCatchEvent, intermediateCatchEvent, intermediateCatchEvent, intermediateThrowEvent, intermediateThrowEvent, intermediateThrowEvent, isBoundaryEventWithStartedCompensation, isCompensationHandler, manualTask, manualTask, moveToActivity, moveToLastExclusiveGateway, moveToLastGateway, moveToLastInclusiveGateway, moveToNode, moveToProcess, parallelGateway, parallelGateway, receiveTask, receiveTask, receiveTask, scriptTask, scriptTask, scriptTask, sendTask, sendTask, sendTask, sequenceFlowId, serviceTask, serviceTask, serviceTask, subProcess, subProcess, subProcess, transaction, transaction, userTask, userTask, userTask

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractFlowElementBuilder

name

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBaseElementBuilder

addExtensionElement, addExtensionElement, asZeebeExpression, createBpmnShape, createChild, createChild, createChild, createChild, createCompensateEventDefinition, createEdge, createEmptyErrorEventDefinition, createEmptyMessageEventDefinition, createErrorEventDefinition, createEscalationEventDefinition, createInstance, createInstance, createMessage, createMessageEventDefinition, createSibling, createSibling, createSignalEventDefinition, createZeebeUserTaskForm, findBpmnEdge, findBpmnPlane, findBpmnShape, findErrorDefinitionForCode, findErrorForNameAndCode, findEscalationForCode, findMessageForName, findProcess, findSignalForName, getCreateSingleChild, getCreateSingleChild, getCreateSingleExtensionElement, id, resizeSubProcess, setCoordinates, setWaypoints, setWaypointsWithSourceAndTarget

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBpmnModelElementBuilder

done, getElement, subProcessDone, throwEventDefinitionDone, transactionDone

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractThrowEventBuilder

protected AbstractThrowEventBuilder(BpmnModelInstance modelInstance,
 E element,
 Class<?> selfType)

Method Details

message

public B message(String messageName)

Sets an event definition for the given message name. If already a message with this name exists it will be used, otherwise a new message is created.

Parameters:

messageName - the name of the message

Returns:

the builder object

messageEventDefinition

public MessageEventDefinitionBuilder messageEventDefinition()

Creates an empty message event definition with an unique id and returns a builder for the message event definition.

Returns:

the message event definition builder object

messageEventDefinition

public MessageEventDefinitionBuilder messageEventDefinition(String id)

Creates an empty message event definition with the given id and returns a builder for the message event definition.

Parameters:

id - the id of the message event definition

Returns:

the message event definition builder object

signal

public B signal(String signalName)

Sets an event definition for the given signal name. If already a signal with this name exists it will be used, otherwise a new signal is created.

Parameters:

signalName - the name of the signal

Returns:

the builder object

signalEventDefinition

public SignalEventDefinitionBuilder signalEventDefinition(String signalName)

Sets an event definition for the given Signal name. If a signal with this name already exists it will be used, otherwise a new signal is created. It returns a builder for the Signal Event Definition.

Parameters:

signalName - the name of the signal

Returns:

the signal event definition builder object

escalation

public B escalation(String escalationCode)

Sets an escalation definition for the given escalation code. If already an escalation with this code exists it will be used, otherwise a new escalation is created.

Parameters:

escalationCode - the code of the escalation

Returns:

the builder object

compensateEventDefinition

public CompensateEventDefinitionBuilder compensateEventDefinition()

compensateEventDefinition

public CompensateEventDefinitionBuilder compensateEventDefinition(String id)

zeebeJobType

public B zeebeJobType(String type)

Description copied from interface: ZeebeJobWorkerPropertiesBuilder

Sets a static type for the job.

Specified by:

zeebeJobType in interface ZeebeJobWorkerPropertiesBuilder<B extends AbstractThrowEventBuilder<B,E>>

Parameters:

type - the type of the job

Returns:

the builder instance

zeebeJobTypeExpression

public B zeebeJobTypeExpression(String expression)

Description copied from interface: ZeebeJobWorkerPropertiesBuilder

Sets a dynamic type for the job that is retrieved from the given expression.

Specified by:

zeebeJobTypeExpression in interface ZeebeJobWorkerPropertiesBuilder<B extends AbstractThrowEventBuilder<B,E>>

Parameters:

expression - the expression for the type of the job

Returns:

the builder instance

zeebeJobRetries

public B zeebeJobRetries(String retries)

Description copied from interface: ZeebeJobWorkerPropertiesBuilder

Sets a static number of retries for the job.

Specified by:

zeebeJobRetries in interface ZeebeJobWorkerPropertiesBuilder<B extends AbstractThrowEventBuilder<B,E>>

Parameters:

retries - the number of job retries

Returns:

the builder instance

zeebeJobRetriesExpression

public B zeebeJobRetriesExpression(String expression)

Description copied from interface: ZeebeJobWorkerPropertiesBuilder

Sets a dynamic number of retries for the job that is retrieved from the given expression

Specified by:

zeebeJobRetriesExpression in interface ZeebeJobWorkerPropertiesBuilder<B extends AbstractThrowEventBuilder<B,E>>

Parameters:

expression - the expression for the number of job retries

Returns:

the builder instance

zeebeTaskHeader

public B zeebeTaskHeader(String key,
 String value)

Description copied from interface: ZeebeJobWorkerPropertiesBuilder

Adds a custom task header for the job. Can be called multiple times.

Specified by:

zeebeTaskHeader in interface ZeebeJobWorkerPropertiesBuilder<B extends AbstractThrowEventBuilder<B,E>>

Parameters:

key - the key of the custom header

value - the value of the custom header

Returns:

the builder instance

zeebeInputExpression

public B zeebeInputExpression(String sourceExpression,
 String target)

Specified by:

zeebeInputExpression in interface ZeebeVariablesMappingBuilder<B extends AbstractThrowEventBuilder<B,E>>

zeebeOutputExpression

public B zeebeOutputExpression(String sourceExpression,
 String target)

Specified by:

zeebeOutputExpression in interface ZeebeVariablesMappingBuilder<B extends AbstractThrowEventBuilder<B,E>>

zeebeInput

public B zeebeInput(String source,
 String target)

Specified by:

zeebeInput in interface ZeebeVariablesMappingBuilder<B extends AbstractThrowEventBuilder<B,E>>

zeebeOutput

public B zeebeOutput(String source,
 String target)

Specified by:

zeebeOutput in interface ZeebeVariablesMappingBuilder<B extends AbstractThrowEventBuilder<B,E>>