Package gg.xp.xivsupport.timelines

Record Class VisualTimelineEntry

java.lang.Object

java.lang.Record

gg.xp.xivsupport.timelines.VisualTimelineEntry

All Implemented Interfaces:

LabelOverride, CurrentMaxPair

public record VisualTimelineEntry(TimelineEntry originalTimelineEntry, boolean isCurrentSync, double timeUntil, int barTimeBasis)
extends Record
implements LabelOverride, CurrentMaxPair

Constructor Summary

Constructors

Constructor	Description
VisualTimelineEntry(TimelineEntry originalTimelineEntry, boolean isCurrentSync, double timeUntil, int barTimeBasis)	Creates an instance of a VisualTimelineEntry record class.

Method Summary

Modifier and Type	Method	Description
int	barTimeBasis()	Returns the value of the barTimeBasis record component.
long	current()
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getLabel()
int	hashCode()	Returns a hash code value for this object.
boolean	isCurrentSync()	Returns the value of the isCurrentSync record component.
long	max()
TimelineEntry	originalTimelineEntry()	Returns the value of the originalTimelineEntry record component.
double	remainingActiveTime()
boolean	shouldDisplay()
double	timeUntil()	Returns the value of the timeUntil 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

Methods inherited from interface gg.xp.xivsupport.models.CurrentMaxPair

getPercent, getShortString, isEmpty, isFull

Constructor Details

VisualTimelineEntry

public VisualTimelineEntry(TimelineEntry originalTimelineEntry,
 boolean isCurrentSync,
 double timeUntil,
 int barTimeBasis)

Creates an instance of a VisualTimelineEntry record class.

Parameters:

originalTimelineEntry - the value for the originalTimelineEntry record component

isCurrentSync - the value for the isCurrentSync record component

timeUntil - the value for the timeUntil record component

barTimeBasis - the value for the barTimeBasis record component

Method Details

getLabel

public String getLabel()

Specified by:

getLabel in interface LabelOverride

shouldDisplay

public boolean shouldDisplay()

current

public long current()

Specified by:

current in interface CurrentMaxPair

max

public long max()

Specified by:

max in interface CurrentMaxPair

remainingActiveTime

public double remainingActiveTime()

equals

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

hashCode

public 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

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

originalTimelineEntry

public TimelineEntry originalTimelineEntry()

Returns the value of the originalTimelineEntry record component.

Returns:

the value of the originalTimelineEntry record component

isCurrentSync

public boolean isCurrentSync()

Returns the value of the isCurrentSync record component.

Returns:

the value of the isCurrentSync record component

timeUntil

public double timeUntil()

Returns the value of the timeUntil record component.

Returns:

the value of the timeUntil record component

barTimeBasis

public int barTimeBasis()

Returns the value of the barTimeBasis record component.

Returns:

the value of the barTimeBasis record component