Package de.xam.featdoc.system

Record Class ResultStep

java.lang.Object
java.lang.Record
de.xam.featdoc.system.ResultStep
Record Components:
scenarioStep - initially causing a chain of system reactions
depth - depth in tree from initial scenario step. 0 = is defined just like this in the scenario; > 0: how indirect the action is triggered
sourceSystem - produced the message
targetSystem - consumed the message
message - result of applying a rule or scenario step
messageComment - an optional comment on the message
rule - defined in any system
public record ResultStep(ScenarioStep scenarioStep, int depth, System sourceSystem, Message message, String messageComment, System targetSystem, @Nullable Rule rule) extends Record

  • Constructor Details

    • ResultStep

      public ResultStep(ScenarioStep scenarioStep, int depth, System sourceSystem, Message message, String messageComment, System targetSystem, @Nullable Rule rule)
      Creates an instance of a ResultStep record class.
      Parameters:
      scenarioStep - the value for the scenarioStep record component
      depth - the value for the depth record component
      sourceSystem - the value for the sourceSystem record component
      message - the value for the message record component
      messageComment - the value for the messageComment record component
      targetSystem - the value for the targetSystem record component
      rule - the value for the rule record component

  • Method Details

    • direct

      public static ResultStep direct(ScenarioStep scenarioStep, int depth, System sourceSystem, Message message, String messageComment, System targetSystem)

    • indirect

      public static ResultStep indirect(ScenarioStep scenarioStep, int depth, System sourceSystem, Message message, String messageComment, System targetSystem, Rule rule)

    • feature

      @Nullable public Feature feature()

    • isScenario

      public boolean isScenario()

    • toString

      public 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • scenarioStep

      public ScenarioStep scenarioStep()
      Returns the value of the scenarioStep record component.
      Returns:
      the value of the scenarioStep record component

    • depth

      public int depth()
      Returns the value of the depth record component.
      Returns:
      the value of the depth record component

    • sourceSystem

      public System sourceSystem()
      Returns the value of the sourceSystem record component.
      Returns:
      the value of the sourceSystem record component

    • message

      public Message message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • messageComment

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

    • targetSystem

      public System targetSystem()
      Returns the value of the targetSystem record component.
      Returns:
      the value of the targetSystem record component

    • rule

      @Nullable public Rule rule()
      Returns the value of the rule record component.
      Returns:
      the value of the rule record component