Record Class Ticker

java.lang.Object
java.lang.Record
net.flectone.pulse.model.value.Ticker
Record Components:
enable - whether the schedule runs
period - the delay between runs, in ticks
public record Ticker(boolean enable, long period) extends Record
A repeating schedule for modules that fire on their own, such as auto messages.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Ticker
    DEFAULT
    A disabled schedule, which every disabled entry collapses to.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Ticker(boolean enable, long period)
    Creates an instance of a Ticker record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enable()
    Returns the value of the enable record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static Ticker
    fromJson(Map<String,Object> map)
    Reads a ticker from its config representation.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    period()
    Returns the value of the period record component.
    Map<String,Object>
    toJson()
    Writes this ticker back to its config representation, omitting the period while disabled.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

    • DEFAULT

      public static final Ticker DEFAULT
      A disabled schedule, which every disabled entry collapses to.

  • Constructor Details

    • Ticker

      public Ticker(boolean enable, long period)
      Creates an instance of a Ticker record class.
      Parameters:
      enable - the value for the enable record component
      period - the value for the period record component

  • Method Details

    • fromJson

      public static Ticker fromJson(Map<String,Object> map)
      Reads a ticker from its config representation. A disabled ticker collapses to DEFAULT, so the period is only read when enabled.
      Parameters:
      map - the raw config values
      Returns:
      the parsed ticker

    • toJson

      public Map<String,Object> toJson()
      Writes this ticker back to its config representation, omitting the period while disabled.
      Returns:
      the config values

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • enable

      public boolean enable()
      Returns the value of the enable record component.
      Returns:
      the value of the enable record component

    • period

      public long period()
      Returns the value of the period record component.
      Returns:
      the value of the period record component