com.realtime.crossfire.jxclient.metaserver

Class MetaserverEntry

java.lang.Object

com.realtime.crossfire.jxclient.metaserver.MetaserverEntry

All Implemented Interfaces:

java.lang.Comparable<MetaserverEntry>

public class MetaserverEntry
extends java.lang.Object
implements java.lang.Comparable<MetaserverEntry>

Represents a response line from the metaserver.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	archBase The server's arch base.
private long	bytesIn The number of bytes received.
private long	bytesOut The number of bytes sent.
private java.lang.String	codeBase The server's code base.
private java.lang.String	comment Returns the server comment.
private java.lang.String	hostname The hostname.
private static java.util.regex.Pattern	HTML_TAG_MATCHER Matches html tags.
private java.lang.String	mapBase The server's map base.
private int	players The number of players.
private int	updateSeconds Time since last update in seconds.
private int	uptimeSeconds The server's uptime in seconds.
private java.lang.String	version Returns the server version.

Constructor Summary

Constructors

Constructor and Description
MetaserverEntry(int updateSeconds, java.lang.String hostname, int players, java.lang.String version, java.lang.String comment, long bytesIn, long bytesOut, int uptimeSeconds, java.lang.String archBase, java.lang.String mapBase, java.lang.String codeBase) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MetaserverEntry o)
boolean	equals(java.lang.Object obj)
java.lang.String	format(java.lang.String format) Returns a formatted string using the given format.
java.lang.String	getArchBase() Returns the server's arch base.
long	getBytesIn() Returns the number of bytes received.
long	getBytesOut() Returns the number of bytes sent.
java.lang.String	getCodeBase() Returns the server's code base.
java.lang.String	getComment() Returns the server comment.
java.lang.String	getHostname() Returns the hostname.
java.lang.String	getMapBase() Returns the server's map base.
int	getPlayers() Returns the number of players.
int	getUpdateSeconds() Returns the time since last update in seconds.
int	getUptimeSeconds() Returns the server's uptime in seconds.
java.lang.String	getVersion() Returns the server version.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

archBase

@NotNull
private final java.lang.String archBase

The server's arch base.

bytesIn

private final long bytesIn

The number of bytes received.

bytesOut

private final long bytesOut

The number of bytes sent.

codeBase

@NotNull
private final java.lang.String codeBase

The server's code base.

comment

@NotNull
private final java.lang.String comment

Returns the server comment.

hostname

@NotNull
private final java.lang.String hostname

The hostname.

HTML_TAG_MATCHER

@NotNull
private static final java.util.regex.Pattern HTML_TAG_MATCHER

Matches html tags.

mapBase

@NotNull
private final java.lang.String mapBase

The server's map base.

players

private final int players

The number of players.

updateSeconds

private final int updateSeconds

Time since last update in seconds.

uptimeSeconds

private final int uptimeSeconds

The server's uptime in seconds.

version

@NotNull
private final java.lang.String version

Returns the server version.

Constructor Detail

MetaserverEntry

public MetaserverEntry(int updateSeconds,
                       @NotNull
                       java.lang.String hostname,
                       int players,
                       @NotNull
                       java.lang.String version,
                       @NotNull
                       java.lang.String comment,
                       long bytesIn,
                       long bytesOut,
                       int uptimeSeconds,
                       @NotNull
                       java.lang.String archBase,
                       @NotNull
                       java.lang.String mapBase,
                       @NotNull
                       java.lang.String codeBase)

Creates a new instance.

Parameters:

updateSeconds - time since last update in seconds

hostname - the hostname

players - the number of players

version - the server version

comment - the server comment

bytesIn - the number of bytes received

bytesOut - the number of bytes sent

uptimeSeconds - the server's uptime in seconds

archBase - the server's arch base

mapBase - the server's map base

codeBase - the server's code base

Method Detail

compareTo

public int compareTo(@NotNull
                     MetaserverEntry o)

Specified by:

compareTo in interface java.lang.Comparable<MetaserverEntry>

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

format

@NotNull
public java.lang.String format(@NotNull
                                        java.lang.String format)

Returns a formatted string using the given format.

Supported format strings:

• %% - a literal % character
• %A - arch base
• %C - server comment
• %D - server comment converted to plain text
• %E - code base
• %H - hostname
• %I - bytes in
• %M - map base
• %O - bytes out
• %P - number of players
• %T - uptime in seconds
• %U - time since last update in seconds
• %V - server version

Parameters:

format - the format

Returns:

the formatted string

getArchBase

@NotNull
public java.lang.String getArchBase()

Returns the server's arch base.

Returns:

the server's arch base

getBytesIn

public long getBytesIn()

Returns the number of bytes received.

Returns:

the number of bytes received

getBytesOut

public long getBytesOut()

Returns the number of bytes sent.

Returns:

the number of bytes sent

getCodeBase

@NotNull
public java.lang.String getCodeBase()

Returns the server's code base.

Returns:

the server's code base

getComment

@NotNull
public java.lang.String getComment()

Returns the server comment.

Returns:

the server comment

getHostname

@NotNull
public java.lang.String getHostname()

Returns the hostname.

Returns:

the hostname

getMapBase

@NotNull
public java.lang.String getMapBase()

Returns the server's map base.

Returns:

the server's map base

getPlayers

public int getPlayers()

Returns the number of players.

Returns:

the number of players

getUpdateSeconds

public int getUpdateSeconds()

Returns the time since last update in seconds.

Returns:

the time in seconds

getUptimeSeconds

public int getUptimeSeconds()

Returns the server's uptime in seconds.

Returns:

the server's uptime in seconds

getVersion

@NotNull
public java.lang.String getVersion()

Returns the server version.

Returns:

the server version

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object