Package com.j3d.engine.interact.macros

Record Class MacroLine

java.lang.Object
java.lang.Record
com.j3d.engine.interact.macros.MacroLine
Record Components:
instructionType - The instruction type
instruction - The instruction
public record MacroLine(InstructionType instructionType, String instruction) extends Record
A single line of a Macro with an InstructionType and the string representing the instruction.
Author:
Lehlogonolo Poole
See Also:

  • Field Details

  • Constructor Details

    • MacroLine

      public MacroLine(InstructionType instructionType, String instruction)
      Creates an instance of a MacroLine record class.
      Parameters:
      instructionType - the value for the instructionType record component
      instruction - the value for the instruction record component

  • Method Details

    • 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

    • read

      public static MacroLine read(String instructionType, String instruction)

    • 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.

    • instructionType

      public InstructionType instructionType()
      Returns the value of the instructionType record component.
      Returns:
      the value of the instructionType record component

    • instruction

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