Record Class LaunchedClient.Licence

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.LaunchedClient.Licence

Record Components:

state - its state

failures - consecutive failed refreshes

lastError - the last refresh error, if one was recorded

Enclosing class:

LaunchedClient

public static record LaunchedClient.Licence(LaunchedClient.LicenceState state, int failures, Optional<String> lastError)
extends Record

A client's licence.

Constructor Summary

Constructors

Constructor	Description
Licence(LaunchedClient.LicenceState state, int failures, Optional<String> lastError)	Creates an instance of a Licence record class.

Method Summary

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

Licence

public Licence(LaunchedClient.LicenceState state,
 int failures,
 Optional<String> lastError)

Creates an instance of a Licence record class.

Parameters:

state - the value for the state record component

failures - the value for the failures record component

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

state

public LaunchedClient.LicenceState state()

Returns the value of the state record component.

Returns:

the value of the state record component

failures

public int failures()

Returns the value of the failures record component.

Returns:

the value of the failures record component

lastError

public Optional<String> lastError()

Returns the value of the lastError record component.

Returns:

the value of the lastError record component