Record Class LauncherEvent.ClientExited

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.LauncherEvent.ClientExited

Record Components:

clientId - the client

exitCode - the process exit code

reason - why

All Implemented Interfaces:

LauncherEvent

Enclosing interface:

LauncherEvent

public static record LauncherEvent.ClientExited(String clientId, long exitCode, LauncherEvent.ExitReason reason)
extends Record
implements LauncherEvent

A client's process exited.

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
ClientExited(String clientId, long exitCode, LauncherEvent.ExitReason reason)	Creates an instance of a ClientExited record class.

Method Summary

Modifier and Type	Method	Description
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.
long	exitCode()	Returns the value of the exitCode record component.
final int	hashCode()	Returns a hash code value for this object.
LauncherEvent.ExitReason	reason()	Returns the value of the reason 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

ClientExited

public ClientExited(String clientId,
 long exitCode,
 LauncherEvent.ExitReason reason)

Creates an instance of a ClientExited record class.

Parameters:

clientId - the value for the clientId record component

exitCode - the value for the exitCode record component

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

clientId

public String clientId()

Returns the value of the clientId record component.

Returns:

the value of the clientId record component

exitCode

public long exitCode()

Returns the value of the exitCode record component.

Returns:

the value of the exitCode record component

reason

public LauncherEvent.ExitReason reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component