Package gg.xp.xivsupport.timelines

Record Class TextFileTimelineEntry

java.lang.Object
java.lang.Record
gg.xp.xivsupport.timelines.TextFileTimelineEntry
All Implemented Interfaces:
TimelineEntry, Serializable, Comparable<TimelineEntry>
public record TextFileTimelineEntry(double time, @Nullable String name, @Nullable Pattern sync, @Nullable Double duration, @NotNull TimelineWindow timelineWindow, @Nullable Double jump, @Nullable String jumpLabel, boolean forceJump, EventSyncController eventSyncController) extends Record implements TimelineEntry, Serializable
See Also:

  • Constructor Details

    • TextFileTimelineEntry

      public TextFileTimelineEntry(double time, @Nullable @Nullable String name, @Nullable @Nullable Pattern sync, @Nullable @Nullable Double duration, @NotNull @NotNull TimelineWindow timelineWindow, @Nullable @Nullable Double jump, @Nullable @Nullable String jumpLabel, boolean forceJump, EventSyncController eventSyncController)
      Creates an instance of a TextFileTimelineEntry record class.
      Parameters:
      time - the value for the time record component
      name - the value for the name record component
      sync - the value for the sync record component
      duration - the value for the duration record component
      timelineWindow - the value for the timelineWindow record component
      jump - the value for the jump record component
      jumpLabel - the value for the jumpLabel record component
      forceJump - the value for the forceJump record component
      eventSyncController - the value for the eventSyncController 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 interface TimelineEntry
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • enabled

      public boolean enabled()
      Specified by:
      enabled in interface TimelineEntry
      Returns:
      Whether this entry is enabled

    • callout

      public boolean callout()
      Specified by:
      callout in interface TimelineEntry
      Returns:
      True if this entry is also a timeline trigger.

    • calloutPreTime

      public double calloutPreTime()
      Specified by:
      calloutPreTime in interface TimelineEntry
      Returns:
      The amount of time before this entry's TimelineEntry.time() that the trigger should fire

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • time

      public double time()
      Returns the value of the time record component.
      Specified by:
      time in interface TimelineEntry
      Returns:
      the value of the time record component

    • name

      @Nullable public @Nullable String name()
      Returns the value of the name record component.
      Specified by:
      name in interface TimelineEntry
      Returns:
      the value of the name record component

    • sync

      @Nullable public @Nullable Pattern sync()
      Returns the value of the sync record component.
      Specified by:
      sync in interface TimelineEntry
      Returns:
      the value of the sync record component

    • duration

      @Nullable public @Nullable Double duration()
      Returns the value of the duration record component.
      Specified by:
      duration in interface TimelineEntry
      Returns:
      the value of the duration record component

    • timelineWindow

      @NotNull public @NotNull TimelineWindow timelineWindow()
      Returns the value of the timelineWindow record component.
      Specified by:
      timelineWindow in interface TimelineEntry
      Returns:
      the value of the timelineWindow record component

    • jump

      @Nullable public @Nullable Double jump()
      Returns the value of the jump record component.
      Specified by:
      jump in interface TimelineEntry
      Returns:
      the value of the jump record component
      See Also:

    • jumpLabel

      @Nullable public @Nullable String jumpLabel()
      Returns the value of the jumpLabel record component.
      Specified by:
      jumpLabel in interface TimelineEntry
      Returns:
      the value of the jumpLabel record component
      See Also:

    • forceJump

      public boolean forceJump()
      Returns the value of the forceJump record component.
      Specified by:
      forceJump in interface TimelineEntry
      Returns:
      the value of the forceJump record component
      See Also:

    • eventSyncController

      public EventSyncController eventSyncController()
      Returns the value of the eventSyncController record component.
      Specified by:
      eventSyncController in interface TimelineEntry
      Returns:
      the value of the eventSyncController record component