Parser for response lines of metaserver response lines. More...

Collaboration diagram for com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser:

Public Member Functions
	MetaserverEntryParser ()
	Creates a new instance. More...

MetaserverEntry	parseLine (@NotNull final String line) throws IOException
	Parses a metaserver response line. More...

Static Public Member Functions
static String	format (@NotNull final MetaserverEntry entry)
	Formats a metaserver entry that returns the metaserver entry when parse with parseEntry(CharSequence). More...

static MetaserverEntry	parseEntry (@NotNull final CharSequence entry)
	Parses a metaserver response line. More...

Private Member Functions
void	clear ()
	Resets values for the current server entry. More...

Static Private Member Functions
static String	replace (@NotNull final String str)
	Replaces characters with may cause parsing issues. More...

Private Attributes
String	archBase = DEFAULT_BASE
	The "archetype base" value for the current server entry. More...

long	bytesIn
	The "bytes in" value for the current server entry. More...

long	bytesOut
	The "bytes out" value for the current server entry. More...

String	codeBase = DEFAULT_BASE
	The "code base" value for the current server entry. More...

String	comment = ""
	The "comment" value for the current server entry. More...

String	hostname
	The "hostname" value for the current server entry. More...

boolean	inSection
	Whether response parsing is withing a server entry. More...

String	mapBase = DEFAULT_BASE
	The "map base" value for the current server entry. More...

int	players
	The "players" value for the current server entry. More...

int	updateSeconds
	The "update seconds" value for the current server entry. More...

int	uptimeSeconds
	The "uptime seconds" value for the current server entry. More...

String	version = UNKNOWN_VERSION
	The "server version" value for the current server entry. More...

Static Private Attributes
static final String	DEFAULT_BASE = "not specified"
	The default for arch base, map base, and code base if none specified. More...

static final Pattern	FIELD_SEPARATOR_PATTERN = Pattern.compile("\\\|")
	The pattern to split a metaserver response line into fields. More...

static final String	UNKNOWN_VERSION = "?"
	The default server version if none specified. More...

Detailed Description

Parser for response lines of metaserver response lines.

Author: Andreas Kirschbaum

Definition at line 34 of file MetaserverEntryParser.java.

Constructor & Destructor Documentation

◆ MetaserverEntryParser()

com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.MetaserverEntryParser ( )

Creates a new instance.

Definition at line 124 of file MetaserverEntryParser.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear ( )

private

Resets values for the current server entry.

Will be called whenever parsing of a new entry starts.

Definition at line 283 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.MetaserverEntryParser(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseLine().

Here is the caller graph for this function:

◆ format()

static String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.format ( @NotNull final MetaserverEntry entry )

static

Formats a metaserver entry that returns the metaserver entry when parse with parseEntry(CharSequence).

Parameters

entry the metaserver entry to format

Returns: the formatted entry

Definition at line 304 of file MetaserverEntryParser.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.replace().

Referenced by com.realtime.crossfire.jxclient.metaserver.ServerCache.saveInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseEntry()

static MetaserverEntry com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry ( @NotNull final CharSequence entry )

static

Parses a metaserver response line.

Parameters

entry the response line to parse

Returns: the metaserver entry or
null
if the line is invalid

Definition at line 134 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.ServerCache.addEntry(), and com.realtime.crossfire.jxclient.metaserver.Metaserver.updateMetaList().

Here is the caller graph for this function:

◆ parseLine()

MetaserverEntry com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseLine ( @NotNull final String line ) throws IOException

Parses a metaserver response line.

Parameters

line	the response line to parse

Returns: the metaserver entry, or
null
if the line is invalid

Exceptions

IOException if the response line is invalid

Definition at line 178 of file MetaserverEntryParser.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), com.realtime.crossfire.jxclient.util.NumberParser.parseInt(), and com.realtime.crossfire.jxclient.util.NumberParser.parseLong().

Referenced by com.realtime.crossfire.jxclient.metaserver.Metaserver.updateMetaList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replace()

static String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.replace ( @NotNull final String str )

staticprivate

Replaces characters with may cause parsing issues.

Parameters

str	the string to replace

Returns: the replaced string

Definition at line 314 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.format().

Here is the caller graph for this function:

Member Data Documentation

◆ archBase

String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.archBase = DEFAULT_BASE

private

The "archetype base" value for the current server entry.

Definition at line 107 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ bytesIn

long com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesIn

private

The "bytes in" value for the current server entry.

Definition at line 91 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ bytesOut

long com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesOut

private

The "bytes out" value for the current server entry.

Definition at line 96 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ codeBase

String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.codeBase = DEFAULT_BASE

private

The "code base" value for the current server entry.

Definition at line 119 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ comment

String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.comment = ""

private

The "comment" value for the current server entry.

html_command is preferred over text_comment.

Definition at line 86 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ DEFAULT_BASE

final String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.DEFAULT_BASE = "not specified"

staticprivate

The default for arch base, map base, and code base if none specified.

Definition at line 46 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear().

◆ FIELD_SEPARATOR_PATTERN

final Pattern com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.FIELD_SEPARATOR_PATTERN = Pattern.compile("\\|")

staticprivate

The pattern to split a metaserver response line into fields.

Definition at line 52 of file MetaserverEntryParser.java.

◆ hostname

String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.hostname

private

The "hostname" value for the current server entry.

Definition at line 68 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ inSection

boolean com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.inSection

private

Whether response parsing is withing a server entry.

Definition at line 57 of file MetaserverEntryParser.java.

◆ mapBase

String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.mapBase = DEFAULT_BASE

private

The "map base" value for the current server entry.

Definition at line 113 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ players

int com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.players

private

The "players" value for the current server entry.

Definition at line 73 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ UNKNOWN_VERSION

final String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.UNKNOWN_VERSION = "?"

staticprivate

The default server version if none specified.

Definition at line 40 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear().

◆ updateSeconds

int com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.updateSeconds

private

The "update seconds" value for the current server entry.

Definition at line 62 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ uptimeSeconds

int com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.uptimeSeconds

private

The "uptime seconds" value for the current server entry.

Definition at line 101 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

◆ version

String com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.version = UNKNOWN_VERSION

private

The "server version" value for the current server entry.

Definition at line 79 of file MetaserverEntryParser.java.

Referenced by com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.parseEntry().

The documentation for this class was generated from the following file:

crossfire-code/jxclient/trunk/src/model/src/main/java/com/realtime/crossfire/jxclient/metaserver/MetaserverEntryParser.java

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MetaserverEntryParser()

Member Function Documentation

◆ clear()

◆ format()

◆ parseEntry()

◆ parseLine()

◆ replace()

Member Data Documentation

◆ archBase

◆ bytesIn

◆ bytesOut

◆ codeBase

◆ comment

◆ DEFAULT_BASE

◆ FIELD_SEPARATOR_PATTERN

◆ hostname

◆ inSection

◆ mapBase

◆ players

◆ UNKNOWN_VERSION

◆ updateSeconds

◆ uptimeSeconds

◆ version