Package dev.itsharshxd.zentrix.api.end

Record Class EndToggleRequest

java.lang.Object

java.lang.Record

dev.itsharshxd.zentrix.api.end.EndToggleRequest

public record EndToggleRequest(boolean enabled, Optional<Boolean> pvp, Optional<EndBorderSettings> border)
extends Record

Immutable request to open or close a game's End access.

Access is an entry gate. Closing it stops new arrivals but never ejects the players and spectators already inside the runtime End, who can still leave through its exit portal.

Constructor Summary

Constructors

Constructor	Description
EndToggleRequest(boolean enabled)
EndToggleRequest(boolean enabled, Optional<Boolean> pvp, Optional<EndBorderSettings> border)	Creates an instance of a EndToggleRequest record class.

Method Summary

Modifier and Type	Method	Description
Optional<EndBorderSettings>	border()	Returns the value of the border record component.
static EndToggleRequest	close()
boolean	enabled()	Returns the value of the enabled 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.
static EndToggleRequest	open()
Optional<Boolean>	pvp()	Returns the value of the pvp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

EndToggleRequest

public EndToggleRequest(boolean enabled,
 Optional<Boolean> pvp,
 Optional<EndBorderSettings> border)

Creates an instance of a EndToggleRequest record class.

Parameters:

enabled - the value for the enabled record component

pvp - the value for the pvp record component

border - the value for the border record component

EndToggleRequest

public EndToggleRequest(boolean enabled)

Method Details

open

public static EndToggleRequest open()

close

public static EndToggleRequest close()

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 '=='.

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.

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component

pvp

public Optional<Boolean> pvp()

Returns the value of the pvp record component.

Returns:

the value of the pvp record component

border

public Optional<EndBorderSettings> border()

Returns the value of the border record component.

Returns:

the value of the border record component