Package io.camunda.zeebe.protocol.record.value

Class ImmutableProcessInstanceModificationActivateInstructionValue

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableProcessInstanceModificationActivateInstructionValue

All Implemented Interfaces:

ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

public final class ImmutableProcessInstanceModificationActivateInstructionValue
extends Object
implements ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

Immutable implementation of ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue.

Use the builder to create immutable instances: ImmutableProcessInstanceModificationActivateInstructionValue.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableProcessInstanceModificationActivateInstructionValue.Builder	Builds instances of type ImmutableProcessInstanceModificationActivateInstructionValue.

Method Summary

Modifier and Type	Method	Description
static ImmutableProcessInstanceModificationActivateInstructionValue.Builder	builder()	Creates a builder for ImmutableProcessInstanceModificationActivateInstructionValue.
static ImmutableProcessInstanceModificationActivateInstructionValue	copyOf(ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue instance)	Creates an immutable copy of a ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableProcessInstanceModificationActivateInstructionValue that have equal attribute values.
long	getAncestorScopeKey()	Returns the key of the ancestor scope to create the new element instance in, or -1 if no specific ancestor is selected.
Set<Long>	getAncestorScopeKeys()	Returns all ancestor scope keys of the element that will be activated.
String	getElementId()	Returns the id of the element to create a new element instance at.
List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue>	getVariableInstructions()	Returns a list of variable instructions (if available), or an empty list.
int	hashCode()	Returns a lazily computed hash code from attributes: elementId, ancestorScopeKey, variableInstructions, ancestorScopeKeys.
String	toString()	Prints the immutable value ProcessInstanceModificationActivateInstructionValue with attribute values.
final ImmutableProcessInstanceModificationActivateInstructionValue	withAncestorScopeKey(long value)	Copy the current immutable object by setting a value for the ancestorScopeKey attribute.
final ImmutableProcessInstanceModificationActivateInstructionValue	withAncestorScopeKeys(Iterable<? extends Long> elements)	Copy the current immutable object with elements that replace the content of ancestorScopeKeys.
final ImmutableProcessInstanceModificationActivateInstructionValue	withAncestorScopeKeys(Long... elements)	Copy the current immutable object with elements that replace the content of ancestorScopeKeys.
final ImmutableProcessInstanceModificationActivateInstructionValue	withElementId(String value)	Copy the current immutable object by setting a value for the elementId attribute.
final ImmutableProcessInstanceModificationActivateInstructionValue	withVariableInstructions(ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue... elements)	Copy the current immutable object with elements that replace the content of variableInstructions.
final ImmutableProcessInstanceModificationActivateInstructionValue	withVariableInstructions(Iterable<? extends ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue> elements)	Copy the current immutable object with elements that replace the content of variableInstructions.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getElementId

public String getElementId()

Returns the id of the element to create a new element instance at.

Specified by:

getElementId in interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

getAncestorScopeKey

public long getAncestorScopeKey()

Returns the key of the ancestor scope to create the new element instance in, or -1 if no specific ancestor is selected.

This key is used for ancestor selection:

By default, the new element instance is created within an existing element instance of the flow scope. For example, when activating an element inside an embedded subprocess and the subprocess is already active.

If there is more than one element instance of the flow scope active then the engine can't decide which element instance to create the new element instance in. Instead, the element instance must be selected by its element instance key. The new element instance is created within the selected element instance.

If the selected element instance is not of the flow scope but from a higher scope (e.g. the process instance key instead of the element instance key of the subprocess) then the engine creates a new element instance of the flow scope first and then creates the new element instance within this scope.

Specified by:

getAncestorScopeKey in interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

getVariableInstructions

public List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue> getVariableInstructions()

Returns a list of variable instructions (if available), or an empty list.

Specified by:

getVariableInstructions in interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

getAncestorScopeKeys

public Set<Long> getAncestorScopeKeys()

Returns all ancestor scope keys of the element that will be activated. The property is set in the event only after the modification is applied.

Specified by:

getAncestorScopeKeys in interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue

withElementId

public final ImmutableProcessInstanceModificationActivateInstructionValue withElementId(String value)

Copy the current immutable object by setting a value for the elementId attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for elementId (can be null)

Returns:

A modified copy of the this object

withAncestorScopeKey

public final ImmutableProcessInstanceModificationActivateInstructionValue withAncestorScopeKey(long value)

Copy the current immutable object by setting a value for the ancestorScopeKey attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for ancestorScopeKey

Returns:

A modified copy of the this object

withVariableInstructions

public final ImmutableProcessInstanceModificationActivateInstructionValue withVariableInstructions(ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue... elements)

Copy the current immutable object with elements that replace the content of variableInstructions.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withVariableInstructions

public final ImmutableProcessInstanceModificationActivateInstructionValue withVariableInstructions(Iterable<? extends ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue> elements)

Copy the current immutable object with elements that replace the content of variableInstructions. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of variableInstructions elements to set

Returns:

A modified copy of this object

withAncestorScopeKeys

public final ImmutableProcessInstanceModificationActivateInstructionValue withAncestorScopeKeys(Long... elements)

Copy the current immutable object with elements that replace the content of ancestorScopeKeys.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withAncestorScopeKeys

public final ImmutableProcessInstanceModificationActivateInstructionValue withAncestorScopeKeys(Iterable<? extends Long> elements)

Copy the current immutable object with elements that replace the content of ancestorScopeKeys. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of ancestorScopeKeys elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableProcessInstanceModificationActivateInstructionValue that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Returns a lazily computed hash code from attributes: elementId, ancestorScopeKey, variableInstructions, ancestorScopeKeys.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ProcessInstanceModificationActivateInstructionValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableProcessInstanceModificationActivateInstructionValue copyOf(ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue instance)

Creates an immutable copy of a ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable ProcessInstanceModificationActivateInstructionValue instance

builder

public static ImmutableProcessInstanceModificationActivateInstructionValue.Builder builder()

Creates a builder for ImmutableProcessInstanceModificationActivateInstructionValue.

 ImmutableProcessInstanceModificationActivateInstructionValue.builder()
    .withElementId(String | null) // nullable elementId
    .withAncestorScopeKey(long) // optional ancestorScopeKey
    .addVariableInstruction|addAllVariableInstructions(io.camunda.zeebe.protocol.record.value.ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue) // variableInstructions elements
    .addAncestorScopeKey|addAllAncestorScopeKeys(Long) // ancestorScopeKeys elements
    .build();
 

Returns:

A new ImmutableProcessInstanceModificationActivateInstructionValue builder