Package modelarium.multithreading

Record Class CoordinatorHandle

java.lang.Object
java.lang.Record
modelarium.multithreading.CoordinatorHandle
Record Components:
coordinatorThread - the thread the co-ordinator runnable is executing on
coordinator - the co-ordinator runnable managing synchronised access to shared simulation state
public record CoordinatorHandle(Thread coordinatorThread, CoordinatorThread coordinator) extends Record
Record for containing the co-ordinator thread and the runnable it executes.

This record is returned when the model launches its co-ordinator, allowing the model to later signal the co-ordinator to shut down and to join the underlying thread.

  • Constructor Details

    • CoordinatorHandle

      public CoordinatorHandle(Thread coordinatorThread, CoordinatorThread coordinator)
      Creates an instance of a CoordinatorHandle record class.
      Parameters:
      coordinatorThread - the value for the coordinatorThread record component
      coordinator - the value for the coordinator 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.

    • coordinatorThread

      public Thread coordinatorThread()
      Returns the value of the coordinatorThread record component.
      Returns:
      the value of the coordinatorThread record component

    • coordinator

      public CoordinatorThread coordinator()
      Returns the value of the coordinator record component.
      Returns:
      the value of the coordinator record component