Record Class LauncherEvent.DataUpdateAvailable

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.LauncherEvent.DataUpdateAvailable

Record Components:

phase - where the update is

stagedSha - the update waiting to be applied, if any

hostsBlocking - how many hosts must close before it applies

applyWhenHostsClose - whether it applies by itself once they do

All Implemented Interfaces:

LauncherEvent

Enclosing interface:

LauncherEvent

public static record LauncherEvent.DataUpdateAvailable(LauncherEvent.DataPhase phase, Optional<String> stagedSha, int hostsBlocking, boolean applyWhenHostsClose)
extends Record
implements LauncherEvent

The state of a data update changed.

Nested Class Summary

Nested classes/interfaces inherited from interface LauncherEvent

LauncherEvent.AgentUpdated, LauncherEvent.ClientExited, LauncherEvent.ClientStarted, LauncherEvent.ClientStateChanged, LauncherEvent.DataPhase, LauncherEvent.DataUpdateApplied, LauncherEvent.DataUpdateAvailable, LauncherEvent.EventsDropped, LauncherEvent.ExitReason, LauncherEvent.LicenceChanged, LauncherEvent.ServiceLost, LauncherEvent.ServiceRestored, LauncherEvent.ServiceShuttingDown

Constructor Summary

Constructors

Constructor	Description
DataUpdateAvailable(LauncherEvent.DataPhase phase, Optional<String> stagedSha, int hostsBlocking, boolean applyWhenHostsClose)	Creates an instance of a DataUpdateAvailable record class.

Method Summary

Modifier and Type	Method	Description
boolean	applyWhenHostsClose()	Returns the value of the applyWhenHostsClose record component.
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.
int	hostsBlocking()	Returns the value of the hostsBlocking record component.
LauncherEvent.DataPhase	phase()	Returns the value of the phase record component.
Optional<String>	stagedSha()	Returns the value of the stagedSha record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DataUpdateAvailable

public DataUpdateAvailable(LauncherEvent.DataPhase phase,
 Optional<String> stagedSha,
 int hostsBlocking,
 boolean applyWhenHostsClose)

Creates an instance of a DataUpdateAvailable record class.

Parameters:

phase - the value for the phase record component

stagedSha - the value for the stagedSha record component

hostsBlocking - the value for the hostsBlocking record component

applyWhenHostsClose - the value for the applyWhenHostsClose 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

phase

public LauncherEvent.DataPhase phase()

Returns the value of the phase record component.

Returns:

the value of the phase record component

stagedSha

public Optional<String> stagedSha()

Returns the value of the stagedSha record component.

Returns:

the value of the stagedSha record component

hostsBlocking

public int hostsBlocking()

Returns the value of the hostsBlocking record component.

Returns:

the value of the hostsBlocking record component

applyWhenHostsClose

public boolean applyWhenHostsClose()

Returns the value of the applyWhenHostsClose record component.

Returns:

the value of the applyWhenHostsClose record component