Record Class LauncherEvent.ClientStateChanged

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.LauncherEvent.ClientStateChanged

Record Components:

clientId - the client

state - its new state

stage - the step it is at, when the service says

code - for LaunchedClient.State.FAILED, the failure code

message - English text about the step, for logs

All Implemented Interfaces:

LauncherEvent

Enclosing interface:

LauncherEvent

public static record LauncherEvent.ClientStateChanged(String clientId, LaunchedClient.State state, Optional<String> stage, Optional<String> code, Optional<String> message)
extends Record
implements LauncherEvent

A client's launch moved on.

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
ClientStateChanged(String clientId, LaunchedClient.State state, Optional<String> stage, Optional<String> code, Optional<String> message)	Creates an instance of a ClientStateChanged record class.

Method Summary

Modifier and Type	Method	Description
String	clientId()	Returns the value of the clientId record component.
Optional<String>	code()	Returns the value of the code 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.
Optional<String>	message()	Returns the value of the message record component.
Optional<String>	stage()	Returns the value of the stage record component.
LaunchedClient.State	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

ClientStateChanged

public ClientStateChanged(String clientId,
 LaunchedClient.State state,
 Optional<String> stage,
 Optional<String> code,
 Optional<String> message)

Creates an instance of a ClientStateChanged record class.

Parameters:

clientId - the value for the clientId record component

state - the value for the state record component

stage - the value for the stage record component

code - the value for the code record component

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

clientId

public String clientId()

Returns the value of the clientId record component.

Returns:

the value of the clientId record component

state

public LaunchedClient.State state()

Returns the value of the state record component.

Returns:

the value of the state record component

stage

public Optional<String> stage()

Returns the value of the stage record component.

Returns:

the value of the stage record component

code

public Optional<String> code()

Returns the value of the code record component.

Returns:

the value of the code record component

message

public Optional<String> message()

Returns the value of the message record component.

Returns:

the value of the message record component