Crossfire JXClient, Trunk
Public Member Functions | Private Member Functions | Private Attributes | List of all members
com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder Class Reference
Collaboration diagram for com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder:
Collaboration graph

Public Member Functions

Collection< StartingMap > finish ()
 
void setArchName (@NotNull final String archName)
 
void setDescription (@NotNull final String description)
 
void setName (@NotNull final String name)
 

Private Member Functions

void addStartingMap ()
 

Private Attributes

String archName
 
String description
 
String name
 
final Collection< StartingMap > startingMaps = new ArrayList<>()
 

Detailed Description

Builder for StartingMap instances while parsing a "replyinfo startingmap" response packet.

Author
Andreas Kirschbaum

Definition at line 37 of file StartingMapBuilder.java.

Member Function Documentation

◆ addStartingMap()

void com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap ( )
private

Adds a new StartingMap entry to startingMaps for the current entry. Resets the current entry.

Definition at line 123 of file StartingMapBuilder.java.

References com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.archName, com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.description, com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.name, and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.startingMaps.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.finish(), and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setArchName().

Here is the caller graph for this function:

◆ finish()

Collection<StartingMap> com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.finish ( )

Finishes parsing.

Returns
all starting map entries

Definition at line 114 of file StartingMapBuilder.java.

References com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap(), and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.startingMaps.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.DefaultCrossfireServerConnection.processStartingMapReplyinfo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setArchName()

void com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setArchName ( @NotNull final String  archName)

Starts a new starting map entry.

Parameters
archNamethe archetype name of the entry

Definition at line 70 of file StartingMapBuilder.java.

References com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap(), com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.archName, com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.description, and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.name.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.DefaultCrossfireServerConnection.processStartingMapReplyinfo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setDescription()

void com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setDescription ( @NotNull final String  description)

Sets the description of the current entry.

Parameters
descriptionthe description

Definition at line 97 of file StartingMapBuilder.java.

References com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.archName, and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.description.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.DefaultCrossfireServerConnection.processStartingMapReplyinfo().

Here is the caller graph for this function:

◆ setName()

void com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setName ( @NotNull final String  name)

Sets the name of the current entry.

Parameters
namethe name

Definition at line 81 of file StartingMapBuilder.java.

References com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.archName, and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.name.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.DefaultCrossfireServerConnection.processStartingMapReplyinfo().

Here is the caller graph for this function:

Member Data Documentation

◆ archName

String com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.archName
private

The archetype name of the current entry. Set to

null

until the first entry was started.

Definition at line 44 of file StartingMapBuilder.java.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap(), com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setArchName(), com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setDescription(), and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setName().

◆ description

String com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.description
private

The description of this entry. Set to

null

if no description has been set yet.

Definition at line 58 of file StartingMapBuilder.java.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap(), com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setArchName(), and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setDescription().

◆ name

String com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.name
private

The proper name of this entry. Set to

null

if no proper name has been set yet.

Definition at line 51 of file StartingMapBuilder.java.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap(), com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setArchName(), and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.setName().

◆ startingMaps

final Collection<StartingMap> com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.startingMaps = new ArrayList<>()
private

The StartingMap entries parsed so far.

Definition at line 64 of file StartingMapBuilder.java.

Referenced by com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.addStartingMap(), and com.realtime.crossfire.jxclient.server.crossfire.StartingMapBuilder.finish().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17