Package com.velocitypowered.api.event.proxy.server

Record Class ServerUnregisteredEvent

java.lang.Object

java.lang.Record

com.velocitypowered.api.event.proxy.server.ServerUnregisteredEvent

Record Components:

unregisteredServer - A RegisteredServer that has been unregistered.

@Beta
public record ServerUnregisteredEvent(@NotNull RegisteredServer unregisteredServer)
extends Record

This event is fired by the proxy after a backend server is unregistered from the server map. Currently, it may occur when a server is unregistered dynamically at runtime or when a server is replaced due to configuration reload.

Since:

3.3.0

See Also:

• ProxyServer.unregisterServer(ServerInfo)

Constructor Summary

Constructors

Constructor	Description
ServerUnregisteredEvent(@NotNull RegisteredServer unregisteredServer)	Creates an instance of a ServerUnregisteredEvent 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.
final String	toString()	Returns a string representation of this record class.
@NotNull RegisteredServer	unregisteredServer()	Returns the value of the unregisteredServer record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerUnregisteredEvent

public ServerUnregisteredEvent(@NotNull
 @NotNull RegisteredServer unregisteredServer)

Creates an instance of a ServerUnregisteredEvent record class.

Parameters:

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

unregisteredServer

@NotNull
public @NotNull RegisteredServer unregisteredServer()

Returns the value of the unregisteredServer record component.

Returns:

the value of the unregisteredServer record component