com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser Class Reference

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

Public Member Functions
	MetaserverEntryParser ()
MetaserverEntry	parseLine (@NotNull final String line) throws IOException

Static Public Member Functions
static String	format (@NotNull final MetaserverEntry entry)
static MetaserverEntry	parseEntry (@NotNull final CharSequence entry)

Private Member Functions
void	clear ()

Static Private Member Functions
static String	replace (@NotNull final String str)

Private Attributes
String	archBase = DEFAULT_BASE
long	bytesIn
long	bytesOut
String	codeBase = DEFAULT_BASE
String	comment = ""
String	hostname
boolean	inSection
String	mapBase = DEFAULT_BASE
int	players
int	port
int	updateSeconds
int	uptimeSeconds
String	version = UNKNOWN_VERSION

Static Private Attributes
static final String	DEFAULT_BASE = "not specified"
static final Pattern	FIELD_SEPARATOR_PATTERN = Pattern.compile("\\|")
static final String	UNKNOWN_VERSION = "?"

Detailed Description

Parser for response lines of metaserver response lines.

Author

Andreas Kirschbaum

Definition at line 35 of file MetaserverEntryParser.java.

Constructor & Destructor Documentation

MetaserverEntryParser()

com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.MetaserverEntryParser

(

)

Creates a new instance.

Definition at line 130 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 289 of file MetaserverEntryParser.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.archBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesIn, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesOut, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.codeBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.comment, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.DEFAULT_BASE, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.hostname, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.mapBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.players, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.port, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.UNKNOWN_VERSION, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.updateSeconds, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.uptimeSeconds, and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.version.

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 311 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 140 of file MetaserverEntryParser.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.archBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesIn, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesOut, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.codeBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.comment, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.FIELD_SEPARATOR_PATTERN, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.hostname, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.mapBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.players, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.updateSeconds, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.uptimeSeconds, and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.version.

Referenced by com.realtime.crossfire.jxclient.metaserver.ServerCache.addEntry(), and com.realtime.crossfire.jxclient.metaserver.DefaultMetaserver.queryMetaserver().

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 183 of file MetaserverEntryParser.java.

References com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.archBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesIn, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.bytesOut, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.clear(), com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.codeBase, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.comment, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.hostname, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.inSection, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.mapBase, com.realtime.crossfire.jxclient.util.NumberParser.parseInt(), com.realtime.crossfire.jxclient.util.NumberParser.parseLong(), com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.players, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.port, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.updateSeconds, com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.uptimeSeconds, and com.realtime.crossfire.jxclient.metaserver.MetaserverEntryParser.version.

Referenced by com.realtime.crossfire.jxclient.metaserver.DefaultMetaserver.queryMetaserver().

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 321 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 113 of file MetaserverEntryParser.java.

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

bytesIn

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

private

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

Definition at line 97 of file MetaserverEntryParser.java.

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

bytesOut

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

private

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

Definition at line 102 of file MetaserverEntryParser.java.

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

codeBase

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

private

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

Definition at line 125 of file MetaserverEntryParser.java.

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

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 92 of file MetaserverEntryParser.java.

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

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 47 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 53 of file MetaserverEntryParser.java.

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

hostname

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

private

The "hostname" value for the current server entry.

Definition at line 69 of file MetaserverEntryParser.java.

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

inSection

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

private

Whether response parsing is withing a server entry.

Definition at line 58 of file MetaserverEntryParser.java.

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

mapBase

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

private

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

Definition at line 119 of file MetaserverEntryParser.java.

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

players

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

private

The "players" value for the current server entry.

Definition at line 79 of file MetaserverEntryParser.java.

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

port

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

private

The "port" value for the current server entry.

Definition at line 74 of file MetaserverEntryParser.java.

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

UNKNOWN_VERSION

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

staticprivate

The default server version if none specified.

Definition at line 41 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 63 of file MetaserverEntryParser.java.

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

uptimeSeconds

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

private

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

Definition at line 107 of file MetaserverEntryParser.java.

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

version

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

private

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

Definition at line 85 of file MetaserverEntryParser.java.

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

---

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

• src/model/src/main/java/com/realtime/crossfire/jxclient/metaserver/MetaserverEntryParser.java