Package com.velocitypowered.api.proxy.server

Class ServerPing

java.lang.Object

com.velocitypowered.api.proxy.server.ServerPing

public final class ServerPing
extends Object

Represents a 1.7 and above server list ping response. This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServerPing.Builder	A builder for ServerPing objects.
static final class	ServerPing.Players	Represents what the players the server purports to have online, its maximum capacity, and a sample of players on the server.
static final class	ServerPing.SamplePlayer	A player returned in the sample field of the server ping players field.
static final class	ServerPing.Version	Represents the version of the server sent to the client.

Constructor Summary

Constructors

Constructor	Description
ServerPing(ServerPing.Version version, @Nullable ServerPing.Players players, Component description, @Nullable Favicon favicon)	Constructs an initial ServerPing instance.
ServerPing(ServerPing.Version version, @Nullable ServerPing.Players players, Component description, @Nullable Favicon favicon, @Nullable ModInfo modinfo)	Constructs a ServerPing instance.

Method Summary

Modifier and Type	Method	Description
ServerPing.Builder	asBuilder()	Returns a copy of this ServerPing instance as a builder so that it can be modified.
static ServerPing.Builder	builder()	Creates a new ServerPing.Builder for constructing a ServerPing.
boolean	equals(Object o)
@Nullable Component	getDescriptionComponent()	Gets the description (MOTD) component shown in the ping response.
Optional<Favicon>	getFavicon()	Gets the favicon sent to the client.
Optional<ModInfo>	getModinfo()	Gets the mod info sent to the client.
Optional<ServerPing.Players>	getPlayers()	Gets the player information shown to the client.
ServerPing.Version	getVersion()	Gets the version shown to the client during the ping.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ServerPing

public ServerPing(ServerPing.Version version,
 @Nullable ServerPing.Players players,
 Component description,
 @Nullable Favicon favicon)

Constructs an initial ServerPing instance.

Parameters:

version - the version of the server

players - the players on the server, or null if not shown

description - the MOTD for the server

favicon - the server's favicon, or null if not set

ServerPing

public ServerPing(ServerPing.Version version,
 @Nullable ServerPing.Players players,
 Component description,
 @Nullable Favicon favicon,
 @Nullable ModInfo modinfo)

Constructs a ServerPing instance.

Parameters:

version - the version of the server

players - the players on the server

description - the MOTD for the server

favicon - the server's favicon

modinfo - the mods this server runs

Method Details

getVersion

public ServerPing.Version getVersion()

Gets the version shown to the client during the ping.

Returns:

the version

getPlayers

public Optional<ServerPing.Players> getPlayers()

Gets the player information shown to the client.

Returns:

the player information, or empty if not shown

getDescriptionComponent

public @Nullable Component getDescriptionComponent()

Gets the description (MOTD) component shown in the ping response.

Returns:

the description component

getFavicon

public Optional<Favicon> getFavicon()

Gets the favicon sent to the client.

Returns:

the favicon, or empty if not present

getModinfo

public Optional<ModInfo> getModinfo()

Gets the mod info sent to the client.

Returns:

the mod info, or empty if not present

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asBuilder

public ServerPing.Builder asBuilder()

Returns a copy of this ServerPing instance as a builder so that it can be modified. It is guaranteed that ping.asBuilder().build().equals(ping) is true: that is, if no other changes are made to the returned builder, the built instance will equal the original instance.

Returns:

a copy of this instance as a ServerPing.Builder

builder

public static ServerPing.Builder builder()

Creates a new ServerPing.Builder for constructing a ServerPing.

Returns:

a new ServerPing builder