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

Record Class ServerRegisteredEvent

java.lang.Object

java.lang.Record

com.velocitypowered.api.event.proxy.server.ServerRegisteredEvent

Record Components:

registeredServer - A RegisteredServer that has been registered.

@Beta
public record ServerRegisteredEvent(@NotNull RegisteredServer registeredServer)
extends Record

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

Since:

3.3.0

See Also:

• ProxyServer.registerServer(ServerInfo)

Constructor Summary

Constructors

Constructor	Description
ServerRegisteredEvent(@NotNull RegisteredServer registeredServer)	Creates an instance of a ServerRegisteredEvent 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.
@NotNull RegisteredServer	registeredServer()	Returns the value of the registeredServer 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

ServerRegisteredEvent

public ServerRegisteredEvent(@NotNull
 @NotNull RegisteredServer registeredServer)

Creates an instance of a ServerRegisteredEvent record class.

Parameters:

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

registeredServer

@NotNull
public @NotNull RegisteredServer registeredServer()

Returns the value of the registeredServer record component.

Returns:

the value of the registeredServer record component