Class FlowchartToBpmnConverterSettings.Builder
- java.lang.Object
-
- de.xima.fc.workflow.converter.bpmn.FlowchartToBpmnConverterSettings.Builder
-
- Enclosing class:
- FlowchartToBpmnConverterSettings
public static final class FlowchartToBpmnConverterSettings.Builder extends Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowchartToBpmnConverterSettings.Builder
alwaysCenterPorts()
Always place in and out ports at the center of aBPMN shape's
side.FlowchartToBpmnConverterSettings.Builder
alwaysCenterPorts(Boolean alwaysCenterPorts)
Sets whether to always place in and out ports at the center of aBPMN shape's
side.FlowchartToBpmnConverterSettings.Builder
axisAlignDiagonalConnections()
Converts diagonal connections to axis-aligned connections.FlowchartToBpmnConverterSettings.Builder
axisAlignDiagonalConnections(boolean axisAlignDiagonalConnections)
Sets whether to convert diagonal connections to axis-aligned connections.FlowchartToBpmnConverterSettings
build()
Build the settings object.FlowchartToBpmnConverterSettings.Builder
includeDefaultValuesInXml()
Include values for attributes in the XML output even if they are equal to their default value.FlowchartToBpmnConverterSettings.Builder
includeDefaultValuesInXml(boolean includeDefaultValuesInXml)
Whether to include values for attributes in the XML output even if they are equal to their default value.FlowchartToBpmnConverterSettings.Builder
inlineEventDefinitionReferences()
Enables inlining event definition references.FlowchartToBpmnConverterSettings.Builder
inlineEventDefinitionReferences(boolean inlineEventDefinitionReferences)
When enabled, affectsevents
witheventDefinitionReferences
.FlowchartToBpmnConverterSettings.Builder
layoutSettings(IWorkflowBpmnLayoutSettings layoutSettings)
Sets the layout settings to use for the BPMN diagram.FlowchartToBpmnConverterSettings.Builder
layoutSettings(Consumer<WorkflowBpmnLayoutSettings.Builder> configurator)
Sets the layout settings to use for the BPMN diagram.FlowchartToBpmnConverterSettings.Builder
locale(Locale locale)
Set the locale to use for localized messages in the BPMN diagram.
-
-
-
Method Detail
-
alwaysCenterPorts
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder alwaysCenterPorts()
Always place in and out ports at the center of aBPMN shape's
side. Some BPMN tools only allowBPMN edges
to connect to specific points on the shape. This setting may improve compatibility with such tools.- Returns:
- This builder instance for method chaining.
-
alwaysCenterPorts
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder alwaysCenterPorts(Boolean alwaysCenterPorts)
Sets whether to always place in and out ports at the center of aBPMN shape's
side. Defaults to false. Some BPMN tools only allowBPMN edges
to connect to specific points on the shape. This setting may improve compatibility with such tools.- Parameters:
alwaysCenterPorts
- Whether to always center ports on the shape's side.- Returns:
- This builder instance for method chaining.
-
axisAlignDiagonalConnections
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder axisAlignDiagonalConnections()
Converts diagonal connections to axis-aligned connections. When enabled, convertswaypoints
ofBPMNEdge
that form a non axis-aligned diagonal path to an axis-aligned path. This is done by approximating the diagonal path with a series of axis-aligned segments. May be useful for tools that don't support diagonal connections.- Returns:
- This builder for chaining method calls.
-
axisAlignDiagonalConnections
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder axisAlignDiagonalConnections(boolean axisAlignDiagonalConnections)
Sets whether to convert diagonal connections to axis-aligned connections. When enabled, convertswaypoints
ofBPMNEdge
that form a non axis-aligned diagonal path to an axis-aligned path. This is done by approximating the diagonal path with a series of axis-aligned segments. May be useful for tools that don't support diagonal connections.- Parameters:
axisAlignDiagonalConnections
- Whether to convert diagonal connections to axis-aligned connections.- Returns:
- This builder for chaining method calls.
-
build
public FlowchartToBpmnConverterSettings build()
Build the settings object. Subsequent changes to the builder will not affect the settings object.- Returns:
- The settings object.
-
includeDefaultValuesInXml
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder includeDefaultValuesInXml()
Include values for attributes in the XML output even if they are equal to their default value. May improve compatibility with some tools that do not respect the default values as per the BPMN 2 standard.- Returns:
- This builder for chaining method calls.
-
includeDefaultValuesInXml
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder includeDefaultValuesInXml(boolean includeDefaultValuesInXml)
Whether to include values for attributes in the XML output even if they are equal to their default value. May improve compatibility with some tools that do not respect the default values as per the BPMN 2 standard.- Returns:
- This builder for chaining method calls.
-
inlineEventDefinitionReferences
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder inlineEventDefinitionReferences()
Enables inlining event definition references.When enabled, affects
events
witheventDefinitionReferences
. Creates a copy of the referenced event and inlines it viaeventDefinitions
. May be useful for tools that don't support that part of the BPMN spec. Defaults to false.- Returns:
- This builder for chaining method calls.
-
inlineEventDefinitionReferences
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder inlineEventDefinitionReferences(boolean inlineEventDefinitionReferences)
When enabled, affectsevents
witheventDefinitionReferences
. Creates a copy of the referenced event and inlines it viaeventDefinitions
. May be useful for tools that don't support that part of the BPMN spec. Defaults to false.- Parameters:
inlineEventDefinitionReferences
- Whether to inline event definition references.- Returns:
- This builder for chaining method calls.
-
layoutSettings
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder layoutSettings(IWorkflowBpmnLayoutSettings layoutSettings)
Sets the layout settings to use for the BPMN diagram. Defaults toWorkflowBpmnLayoutSettings
.- Parameters:
layoutSettings
- The layout settings to use for the BPMN diagram. null to use the default.- Returns:
- This builder for chaining method calls.
-
layoutSettings
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder layoutSettings(Consumer<WorkflowBpmnLayoutSettings.Builder> configurator)
Sets the layout settings to use for the BPMN diagram. Defaults toWorkflowBpmnLayoutSettings
.- Parameters:
configurator
- A consumer that configures the layout settings via the provided builder.- Returns:
- This builder for chaining method calls.
-
locale
@CanIgnoreReturnValue public FlowchartToBpmnConverterSettings.Builder locale(Locale locale)
Set the locale to use for localized messages in the BPMN diagram. Defaults to English.- Parameters:
locale
- The locale to use for the BPMN diagram. null to use the default.- Returns:
- This builder for chaining method calls.
-
-