net.lenni0451.mcping.responses

Interface IPingResponse

All Known Implementing Classes:

BedrockPingResponse, ClassicPingResponse, MCPingResponse, QueryPingResponse, SocketPingResponse

public interface IPingResponse

Marker interface for all possible ping responses.
Some methods exist for common values, but not all responses have all values.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getAddress() Get the address of the server.
default java.lang.String	getFavicon() Get the favicon of the server.
default int	getMaxPlayers() Get the maximum amount of players that can be online on the server.
default java.lang.String	getMotd() Get the MOTD of the server.
default int	getOnlinePlayers() Get the amount of players currently online on the server.
default long	getPing() Get the ping to the server in milliseconds.
default int	getPort() Get the port of the server.
default int	getProtocolId() Get the protocol id of the server.
default java.util.List<java.lang.String>	getSample() Get a sample of players on the server.
default java.lang.String	getVersionName() Get the version name of the server.

Method Detail

getAddress

@Nonnull
default java.lang.String getAddress()

Get the address of the server.

Implemented: MCPingResponse, ClassicPingResponse, BedrockPingResponse, QueryPingResponse, SocketPingResponse
Default: "Unknown"

Returns:

The address

getPort

default int getPort()

Get the port of the server.

Implemented: MCPingResponse, ClassicPingResponse, BedrockPingResponse, QueryPingResponse, SocketPingResponse
Default: -1

Returns:

The port

getMotd

@Nonnull
default java.lang.String getMotd()

Get the MOTD of the server.
The MOTD can be a text component but is not guaranteed to be one.

Implemented: MCPingResponse, ClassicPingResponse, BedrockPingResponse, QueryPingResponse
Default: "Unknown"

Returns:

The MOTD

getFavicon

@Nullable
default java.lang.String getFavicon()

Get the favicon of the server.
The favicon is a base64 encoded png image. The server can send any string here, so it is not guaranteed to be a valid image.

Implemented: MCPingResponse
Default: null

Returns:

The favicon

getPing

default long getPing()

Get the ping to the server in milliseconds.

Implemented: MCPingResponse, ClassicPingResponse, BedrockPingResponse, QueryPingResponse, SocketPingResponse
Default: -1

Returns:

The ping

getOnlinePlayers

default int getOnlinePlayers()

Get the amount of players currently online on the server.

Implemented: MCPingResponse, BedrockPingResponse, QueryPingResponse
Default: -1

Returns:

The amount of players

getMaxPlayers

default int getMaxPlayers()

Get the maximum amount of players that can be online on the server.

Implemented: MCPingResponse, BedrockPingResponse, QueryPingResponse
Default: -1

Returns:

The maximum amount of players

getVersionName

@Nonnull
default java.lang.String getVersionName()

Get the version name of the server.

Implemented: MCPingResponse, BedrockPingResponse, QueryPingResponse
Default: "Unknown"

Returns:

The version name

getProtocolId

default int getProtocolId()

Get the protocol id of the server.

Implemented: MCPingResponse, ClassicPingResponse, BedrockPingResponse, QueryPingResponse
Default: -1

Returns:

The protocol id

getSample

@Nonnull
default java.util.List<java.lang.String> getSample()

Get a sample of players on the server.
The server can send any list of strings here, so it is not guaranteed to be valid player names.
Some implementations may return some general information about the server here (e.g. BedrockPingResponse).
The list can be unmodifiable.

Implemented: MCPingResponse, BedrockPingResponse, QueryPingResponse

Returns:

The sample players