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
cause - produced the message
effect - consumed the message. Can be null for outgoing messages.
public record ResultStep(ScenarioStep scenarioStep, int depth, Cause cause, @Nullable Effect effect) extends Record

  • Constructor Details

    • ResultStep

      public ResultStep(ScenarioStep scenarioStep, int depth, Cause cause, @Nullable Effect effect)
      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
      cause - the value for the cause record component
      effect - the value for the effect record component

  • Method Details

    • indirect

      public static ResultStep indirect(ScenarioStep scenarioStep, int depth, Cause cause, Effect effect)

    • effectComment

      @Nullable public String effectComment()

    • effectSystem

      @Nullable public System effectSystem()

    • isScenario

      public boolean isScenario()

    • message

      public Message message()

    • rules

      public Stream<Rule> rules()

    • 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

    • cause

      public Cause cause()
      Returns the value of the cause record component.
      Returns:
      the value of the cause record component

    • effect

      @Nullable public Effect effect()
      Returns the value of the effect record component.
      Returns:
      the value of the effect record component