Record Class LauncherEvent.LicenceChanged

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.LauncherEvent.LicenceChanged

Record Components:

link - the link: "live", "reconnecting", "terminal" or "closed"

clientId - the client, when the change is one client's licence

state - that licence's state

failures - its consecutive failures

All Implemented Interfaces:

LauncherEvent

Enclosing interface:

LauncherEvent

public static record LauncherEvent.LicenceChanged(String link, Optional<String> clientId, Optional<LaunchedClient.LicenceState> state, OptionalInt failures)
extends Record
implements LauncherEvent

The licence link, or one client's licence, 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
LicenceChanged(String link, Optional<String> clientId, Optional<LaunchedClient.LicenceState> state, OptionalInt failures)	Creates an instance of a LicenceChanged record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	clientId()	Returns the value of the clientId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
OptionalInt	failures()	Returns the value of the failures record component.
final int	hashCode()	Returns a hash code value for this object.
String	link()	Returns the value of the link record component.
Optional<LaunchedClient.LicenceState>	state()	Returns the value of the state 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

LicenceChanged

public LicenceChanged(String link,
 Optional<String> clientId,
 Optional<LaunchedClient.LicenceState> state,
 OptionalInt failures)

Creates an instance of a LicenceChanged record class.

Parameters:

link - the value for the link record component

clientId - the value for the clientId record component

state - the value for the state record component

failures - the value for the failures 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. 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.

link

public String link()

Returns the value of the link record component.

Returns:

the value of the link record component

clientId

public Optional<String> clientId()

Returns the value of the clientId record component.

Returns:

the value of the clientId record component

state

public Optional<LaunchedClient.LicenceState> state()

Returns the value of the state record component.

Returns:

the value of the state record component

failures

public OptionalInt failures()

Returns the value of the failures record component.

Returns:

the value of the failures record component