Package io.camunda.zeebe.engine.state.immutable

Interface VariableState

All Known Subinterfaces:

MutableVariableState

All Known Implementing Classes:

DbVariableState

public interface VariableState

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	VariableState.Variable	Data wrapper for a variable.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	NO_PARENT	The value of the parent scope key for scope with no parents.

Method Summary

Modifier and Type	Method	Description
long	getParentScopeKey(long childScopeKey)
org.agrona.DirectBuffer	getVariable(long scopeKey, org.agrona.DirectBuffer name)
org.agrona.DirectBuffer	getVariable(long scopeKey, org.agrona.DirectBuffer name, int nameOffset, int nameLength)
VariableInstance	getVariableInstanceLocal(long scopeKey, org.agrona.DirectBuffer name)
org.agrona.DirectBuffer	getVariableLocal(long scopeKey, org.agrona.DirectBuffer name)
org.agrona.DirectBuffer	getVariablesAsDocument(long scopeKey)
org.agrona.DirectBuffer	getVariablesAsDocument(long scopeKey, Collection<org.agrona.DirectBuffer> names)
List<VariableState.Variable>	getVariablesLocal(long scopeKey)	Returns a list of all variables at the given scope key.
org.agrona.DirectBuffer	getVariablesLocalAsDocument(long scopeKey)
boolean	isEmpty()

Field Details

NO_PARENT

static final long NO_PARENT

The value of the parent scope key for scope with no parents.

See Also:

• Constant Field Values

Method Details

getVariableLocal

org.agrona.DirectBuffer getVariableLocal(long scopeKey,
 org.agrona.DirectBuffer name)

getVariable

org.agrona.DirectBuffer getVariable(long scopeKey,
 org.agrona.DirectBuffer name)

getVariable

org.agrona.DirectBuffer getVariable(long scopeKey,
 org.agrona.DirectBuffer name,
 int nameOffset,
 int nameLength)

getVariablesAsDocument

org.agrona.DirectBuffer getVariablesAsDocument(long scopeKey)

getVariablesAsDocument

org.agrona.DirectBuffer getVariablesAsDocument(long scopeKey,
 Collection<org.agrona.DirectBuffer> names)

getVariablesLocalAsDocument

org.agrona.DirectBuffer getVariablesLocalAsDocument(long scopeKey)

isEmpty

boolean isEmpty()

getVariablesLocal

List<VariableState.Variable> getVariablesLocal(long scopeKey)

Returns a list of all variables at the given scope key.

This method differs from most other methods on this interface in that it does not traverse the scope hierarchy. It only returns variables that are directly stored at the given scope key.

Parameters:

scopeKey - the scope key to get the variables for

Returns:

a list of all variables at the given scope key

getVariableInstanceLocal

VariableInstance getVariableInstanceLocal(long scopeKey,
 org.agrona.DirectBuffer name)

getParentScopeKey

long getParentScopeKey(long childScopeKey)

Returns:

returns the parent scope key of the given childScopeKey, or NO_PARENT