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

Record Class VersionStepDefinition

java.lang.Object
java.lang.Record
io.axoniq.framework.workflow.dsl.api.VersionStepDefinition
Record Components:
primitiveMetadata - metadata of the primitive (stepName == changeId).
newVersion - new workflow version to record (semver string).
public record VersionStepDefinition(PrimitiveMetadata primitiveMetadata, String newVersion) extends Record
Specification for a ctx.migrateVersion(changeId, newVersion) call. The changeId is carried on PrimitiveMetadata.stepName(); newVersion is the value being recorded.
Since:
5.4.0
Author:
Stefan Dragisic

  • Constructor Details

    • VersionStepDefinition

      public VersionStepDefinition(PrimitiveMetadata primitiveMetadata, String newVersion)
      Fails fast when a mandatory component is null; the package's null-marked contract alone is not enforced at runtime, so a user ignoring it is detected here at construction.

  • Method Details

    • primitiveMetadata

      public VersionStepDefinition primitiveMetadata(PrimitiveMetadata primitiveMetadata)
      Returns a copy of this definition with the provided primitive metadata.

    • stepName

      public VersionStepDefinition stepName(String stepName)
      Returns a copy of this definition with the provided step name. For migration steps the step name carries the developer-chosen changeId.

    • eventNameCustomizer

      public VersionStepDefinition eventNameCustomizer(EventNameCustomizer eventNameCustomizer)
      Returns a copy of this definition with the provided event name customizer.

    • newVersion

      public VersionStepDefinition newVersion(String newVersion)
      Returns a copy of this definition with the provided new version (semver string).

    • 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

    • newVersion

      public String newVersion()
      Returns the value of the newVersion record component.
      Returns:
      the value of the newVersion record component