Package dev.twilite.game.common

Record Class Clockwork.Seed

java.lang.Object
java.lang.Record
dev.twilite.game.common.Clockwork.Seed
Enclosing class:
Clockwork
public static record Clockwork.Seed(Clock clock) extends Record
Builder-style entry point for creating a clock.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Seed(Clock clock)
    Creates an instance of a Seed record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Clock
    clock()
    Returns the value of the clock record component.
    Clockwork
    countdown(Duration window)
    Creates a countdown clock for the supplied duration.
    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.
    Clockwork
    open()
    Creates an open-ended clock.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Seed

      public Seed(Clock clock)
      Creates an instance of a Seed record class.
      Parameters:
      clock - the value for the clock record component

  • Method Details

    • open

      public Clockwork open()
      Creates an open-ended clock.

    • countdown

      public Clockwork countdown(Duration window)
      Creates a countdown clock for the supplied duration.

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

    • clock

      public Clock clock()
      Returns the value of the clock record component.
      Returns:
      the value of the clock record component