Record Class NexoriCloseMatchAdmissionRequest

java.lang.Object

java.lang.Record

io.github.hyjn.nexori.plugin.api.minigame.NexoriCloseMatchAdmissionRequest

Record Components:

matchId - Nexori local match id.

reason - public reason for closing admission.

message - optional human-readable context for logs and diagnostics.

public record NexoriCloseMatchAdmissionRequest(String matchId, NexoriCloseMatchAdmissionReason reason, @Nullable String message)
extends Record

Request to close match admission/backfill visibility for one active backend-driven match.

Use this when a rules mod reaches a point where additional players should no longer be admitted to the match. The request affects admission reporting; it does not submit the final result or return players to lobby.

Constructor Summary

Constructors

Constructor	Description
NexoriCloseMatchAdmissionRequest(String matchId, NexoriCloseMatchAdmissionReason reason, String message)	Creates an instance of a NexoriCloseMatchAdmissionRequest record class.

Method Summary

Modifier and Type	Method	Description
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.
String	matchId()	Returns the value of the matchId record component.
String	message()	Returns the value of the message record component.
NexoriCloseMatchAdmissionReason	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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NexoriCloseMatchAdmissionRequest

public NexoriCloseMatchAdmissionRequest(String matchId,
 NexoriCloseMatchAdmissionReason reason,
 @Nullable
 String message)

Creates an instance of a NexoriCloseMatchAdmissionRequest record class.

Parameters:

matchId - the value for the matchId record component

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

matchId

public String matchId()

Returns the value of the matchId record component.

Returns:

the value of the matchId record component

reason

public NexoriCloseMatchAdmissionReason reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

message

@Nullable
public String message()

Returns the value of the message record component.

Returns:

the value of the message record component