net.lenni0451.mcping.responses

Class MCPingResponse

java.lang.Object

net.lenni0451.mcping.responses.MCPingResponse

All Implemented Interfaces:

IPingResponse

public class MCPingResponse
extends java.lang.Object
implements IPingResponse

The response of a ModernPing and LegacyPing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MCPingResponse.ForgeData
static class	MCPingResponse.ModInfo
static class	MCPingResponse.Players
static class	MCPingResponse.Server
static class	MCPingResponse.Version

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
DescriptionType	descriptionType
java.lang.String	favicon
MCPingResponse.ForgeData	forgeData
MCPingResponse.ModInfo	modinfo
MCPingResponse.Players	players
java.lang.Boolean	previewsChat
MCPingResponse.Server	server
MCPingResponse.Version	version

Constructor Summary

Constructors

Constructor and Description
MCPingResponse()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

description

public java.lang.String description

descriptionType

public DescriptionType descriptionType

favicon

public java.lang.String favicon

server

public MCPingResponse.Server server

previewsChat

public java.lang.Boolean previewsChat

version

public MCPingResponse.Version version

players

public MCPingResponse.Players players

modinfo

public MCPingResponse.ModInfo modinfo

forgeData

public MCPingResponse.ForgeData forgeData

Constructor Detail

MCPingResponse

public MCPingResponse()

Method Detail

getAddress

@Nonnull
public java.lang.String getAddress()

Description copied from interface: IPingResponse

Get the address of the server.

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

Specified by:

getAddress in interface IPingResponse

Returns:

The address

getPort

public int getPort()

Description copied from interface: IPingResponse

Get the port of the server.

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

Specified by:

getPort in interface IPingResponse

Returns:

The port

getMotd

@Nonnull
public java.lang.String getMotd()

Description copied from interface: IPingResponse

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"

Specified by:

getMotd in interface IPingResponse

Returns:

The MOTD

getFavicon

@Nullable
public java.lang.String getFavicon()

Description copied from interface: IPingResponse

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

Specified by:

getFavicon in interface IPingResponse

Returns:

The favicon

getPing

public long getPing()

Description copied from interface: IPingResponse

Get the ping to the server in milliseconds.

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

Specified by:

getPing in interface IPingResponse

Returns:

The ping

getOnlinePlayers

public int getOnlinePlayers()

Description copied from interface: IPingResponse

Get the amount of players currently online on the server.

Implemented: MCPingResponse, BedrockPingResponse, QueryPingResponse
Default: -1

Specified by:

getOnlinePlayers in interface IPingResponse

Returns:

The amount of players

getMaxPlayers

public int getMaxPlayers()

Description copied from interface: IPingResponse

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

Implemented: MCPingResponse, BedrockPingResponse, QueryPingResponse
Default: -1

Specified by:

getMaxPlayers in interface IPingResponse

Returns:

The maximum amount of players

getVersionName

@Nonnull
public java.lang.String getVersionName()

Description copied from interface: IPingResponse

Get the version name of the server.

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

Specified by:

getVersionName in interface IPingResponse

Returns:

The version name

getProtocolId

public int getProtocolId()

Description copied from interface: IPingResponse

Get the protocol id of the server.

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

Specified by:

getProtocolId in interface IPingResponse

Returns:

The protocol id

getSample

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

Description copied from interface: IPingResponse

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

Specified by:

getSample in interface IPingResponse

Returns:

The sample players

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object