Package io.axoniq.framework.workflow.dsl.api

Record Class CancelWorkflowDefinition

java.lang.Object
java.lang.Record
io.axoniq.framework.workflow.dsl.api.CancelWorkflowDefinition
Record Components:
primitiveMetadata - metadata of the primitive
cause - optional cancellation cause
public record CancelWorkflowDefinition(PrimitiveMetadata primitiveMetadata, @Nullable Throwable cause) extends Record
Specification for terminating a workflow with cancellation.
Since:
5.4.0
Author:
Simon Zambrovski

  • Constructor Details

    • CancelWorkflowDefinition

      public CancelWorkflowDefinition(PrimitiveMetadata primitiveMetadata, @Nullable Throwable cause)
      Creates an instance of a CancelWorkflowDefinition record class.
      Parameters:
      primitiveMetadata - the value for the primitiveMetadata record component
      cause - the value for the cause record component

  • Method Details

    • primitiveMetadata

      public CancelWorkflowDefinition primitiveMetadata(PrimitiveMetadata primitiveMetadata)
      Returns a copy of this definition with the provided primitive metadata.
      Parameters:
      primitiveMetadata - metadata of the primitive
      Returns:
      copied workflow definition with updated metadata

    • eventNameCustomizer

      public CancelWorkflowDefinition eventNameCustomizer(EventNameCustomizer eventNameCustomizer)
      Returns a copy of this definition with the provided event name customizer.
      Parameters:
      eventNameCustomizer - customizer for published event names
      Returns:
      copied workflow definition with updated event naming

    • cause

      public CancelWorkflowDefinition cause(@Nullable Throwable cause)
      Returns a copy of this definition with the provided cancellation cause.
      Parameters:
      cause - optional cancellation cause
      Returns:
      copied workflow definition with updated cancellation cause

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • primitiveMetadata

      public PrimitiveMetadata primitiveMetadata()
      Returns the value of the primitiveMetadata record component.
      Returns:
      the value of the primitiveMetadata record component

    • cause

      public @Nullable Throwable cause()
      Returns the value of the cause record component.
      Returns:
      the value of the cause record component