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

Class ImmutableProcessInstanceModificationVariableInstructionValue

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableProcessInstanceModificationVariableInstructionValue

All Implemented Interfaces:

ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue

@ParametersAreNonnullByDefault
@Immutable
public final class ImmutableProcessInstanceModificationVariableInstructionValue
extends Object
implements ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue

Immutable implementation of ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableProcessInstanceModificationVariableInstructionValue.Builder	builder()	Creates a builder for ImmutableProcessInstanceModificationVariableInstructionValue.
static ImmutableProcessInstanceModificationVariableInstructionValue	copyOf(ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue instance)	Creates an immutable copy of a ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableProcessInstanceModificationVariableInstructionValue that have equal attribute values.
String	getElementId()	Returns the element id of the scope where the variables should be created in, or an empty string if the variables are global for the process instance.
Map<String,Object>	getVariables()	Returns the variables of this instruction.
int	hashCode()	Returns a lazily computed hash code from attributes: variables, elementId.
String	toString()	Prints the immutable value ProcessInstanceModificationVariableInstructionValue with attribute values.
final ImmutableProcessInstanceModificationVariableInstructionValue	withElementId(String value)	Copy the current immutable object by setting a value for the elementId attribute.
final ImmutableProcessInstanceModificationVariableInstructionValue	withVariables(Map<String,? extends Object> entries)	Copy the current immutable object by replacing the variables map with the specified map.

Methods inherited from class java.lang.Object

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

Method Details

getVariables

public Map<String,Object> getVariables()

Returns the variables of this instruction. Can be empty.

Specified by:

getVariables in interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue

getElementId

public String getElementId()

Returns the element id of the scope where the variables should be created in, or an empty string if the variables are global for the process instance.

Specified by:

getElementId in interface ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue

withVariables

public final ImmutableProcessInstanceModificationVariableInstructionValue withVariables(Map<String,? extends Object> entries)

Copy the current immutable object by replacing the variables map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the variables map

Returns:

A modified copy of this object

withElementId

public final ImmutableProcessInstanceModificationVariableInstructionValue 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

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutableProcessInstanceModificationVariableInstructionValue 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: variables, elementId.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ProcessInstanceModificationVariableInstructionValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableProcessInstanceModificationVariableInstructionValue copyOf(ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue instance)

Creates an immutable copy of a ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue 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 ProcessInstanceModificationVariableInstructionValue instance

builder

public static ImmutableProcessInstanceModificationVariableInstructionValue.Builder builder()

Creates a builder for ImmutableProcessInstanceModificationVariableInstructionValue.

 ImmutableProcessInstanceModificationVariableInstructionValue.builder()
    .putVariable|putAllVariables(String => Object) // variables mappings
    .withElementId(String | null) // nullable elementId
    .build();
 

Returns:

A new ImmutableProcessInstanceModificationVariableInstructionValue builder