Module com.github.sormuras.bach
Package com.github.sormuras.bach

Record Class Logbook.ToolRunNote

java.lang.Object
java.lang.Record
com.github.sormuras.bach.Logbook.ToolRunNote
All Implemented Interfaces:
Logbook.Note
Enclosing class:
Logbook
public static record Logbook.ToolRunNote(ToolRun run, String description) extends Record implements Logbook.Note
A note indicating that a tool was run with a detailed description.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolRunNote(ToolRun run, String description)
    Creates an instance of a ToolRunNote record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    ToolRun
    run()
    Returns the value of the run record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ToolRunNote

      public ToolRunNote(ToolRun run, String description)
      Creates an instance of a ToolRunNote record class.
      Parameters:
      run - the value for the run record component
      description - the value for the description record component

  • Method Details

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

    • run

      public ToolRun run()
      Returns the value of the run record component.
      Returns:
      the value of the run record component

    • description

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