Package megamek.common.net.packets

Record Class Packet

java.lang.Object

java.lang.Record

megamek.common.net.packets.Packet

All Implemented Interfaces:

Serializable

public record Packet(PacketCommand command, Object[] data)
extends Record
implements Serializable

Application layer data packet used to exchange information between client and server.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Packet(PacketCommand command, Object... data)	Creates a Packet with a command and an array of objects

Method Summary

Modifier and Type	Method	Description
PacketCommand	command()	Returns the value of the command record component.
Object[]	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Vector<ArtilleryAttackAction>	getArtilleryAttackAction(int index)
Set<BoardDimensions>	getBoardDimensionsSet(int index)
Map<BoardLocation,Hex>	getBoardLocationHexMap(int index)
HashMap<BoardLocation,Integer>	getBoardLocationIntegerMap(int index)
boolean	getBooleanValue(int index)
List<IBuilding>	getBuildingList(int index)
Coords	getCoords(int index)
HashSet<Coords>	getCoordsHashSet(int index)
Vector<Coords>	getCoordsVector(int index)
Map<Coords,List<ICarryable>>	getCoordsWithGroundObjectListMap(int index)
Map<Coords,Collection<SpecialHexDisplay>>	getCoordsWithSpecialHexDisplayCollectionMap(int index)
List<EnemyArtilleryInbound>	getEnemyArtilleryInbound(int index)
Entity	getEntity(int index)
List<EntityAction>	getEntityActionList(int index)
List<Entity>	getEntityList(int index)
FighterSquadron	getFighterSquadron(int index)
Vector<Flare>	getFlareVector(int index)
Force	getForce(int index)
List<Force>	getForceList(int index)
Forces	getForces(int index)
GameOptions	getGameOptions(int index)
List<GameTurn>	getGameTurnList(int index)
Hex	getHex(int index)
Vector<IBasicOption>	getIBasicOptionVector(int index)
InGameObject	getInGameObject(int index)
List<InGameObject>	getInGameObjectList(int index)
Map<Integer,List<SBFReportEntry>>	getIntegerWithSBFReportEntryList(int index)
List<Integer>	getIntList(int index)
Map<Integer,Integer>	getIntMapToInt(int index)
int	getIntValue(int index)
MapSettings	getMapSettings(int index)
Minefield	getMinefield(int index)
Vector<Minefield>	getMinefieldVector(int index)
MovePath	getMovePath(int index)
Object	getObject(int index)
PacketCommand	getPacketCommand(int index)
PlanetaryConditions	getPlanetaryConditions(int index)
Player	getPlayer(int index)
PlayerIDAndList<BoardLocation>	getPlayerIDAndListWithBoardLocation(int index)
Vector<Player>	getPlayerVector(int index)
List<Report>	getReportList(int index)
List<List<Report>>	getReportListOfList(int index)
SBFMovePath	getSBFMovePath(int index)
List<SBFReportEntry>	getSBFReportEntryList(int index)
List<SBFTurn>	getSBFTurnList(int index)
SmokeCloud	getSmokeCloud(int index)
SpecialHexDisplay	getSpecialHexDisplay(int index)
String	getStringValue(int index)
Map<String,BehaviorSettings>	getStringWIthBehaviorSettingsMap(int index)
Vector<TagInfo>	getTagInfoVector(int index)
TemporaryECMField	getTemporaryECMField(int index)
Vector<UnitLocation>	getUnitLocationVector(int index)
List<WeaponAttackAction>	getWeaponAttackActionList(int index)
WeaponSortOrder	getWeaponSortOrder(int index)
final int	hashCode()	Returns a hash code value for this object.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Packet

public Packet(PacketCommand command,
 Object... data)

Creates a Packet with a command and an array of objects

Method Details

command

public PacketCommand command()

Returns the value of the command record component.

Returns:

the value of the command record component

data

public Object[] data()

Returns the value of the data record component.

Returns:

the value of the data record component

getObject

@Nullable
public Object getObject(int index)

Parameters:

index - the index of the desired object

Returns:

the object at the specified index

getIntValue

public int getIntValue(int index)
                throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the int value of the object at the specified index

Throws:

InvalidPacketDataException

getIntList

public List<Integer> getIntList(int index)
                         throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of Integer's value of the object at the specified index

Throws:

InvalidPacketDataException

getIntMapToInt

public Map<Integer,Integer> getIntMapToInt(int index)
                                    throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Map of Integer to Integer's value of the object at the specified index

Throws:

InvalidPacketDataException

getIntegerWithSBFReportEntryList

public Map<Integer,List<SBFReportEntry>> getIntegerWithSBFReportEntryList(int index)
                                                                   throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Map of Coords key's with a Collection of SpecialHexDisplay value's of the object at the specified index

Throws:

InvalidPacketDataException

getBooleanValue

public boolean getBooleanValue(int index)
                        throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the boolean value of the object at the specified index

Throws:

InvalidPacketDataException

getStringValue

@Nullable
public String getStringValue(int index)
                      throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the String value of the object at the specified index

Throws:

InvalidPacketDataException

getStringWIthBehaviorSettingsMap

public Map<String,BehaviorSettings> getStringWIthBehaviorSettingsMap(int index)
                                                              throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Map of String key's with BehaviorSettings value's of the object at the specified index

Throws:

InvalidPacketDataException

getArtilleryAttackAction

public Vector<ArtilleryAttackAction> getArtilleryAttackAction(int index)
                                                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of ArtilleryAttackAction's value of the object at the specified index

Throws:

InvalidPacketDataException

getEnemyArtilleryInbound

public List<EnemyArtilleryInbound> getEnemyArtilleryInbound(int index)

Parameters:

index - the index of the desired object

Returns:

the EnemyArtilleryInbound entries at the specified index, or an empty list if the object is absent (e.g. an older packet without this field) or not a list

getBoardDimensionsSet

public Set<BoardDimensions> getBoardDimensionsSet(int index)
                                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Set of BoardDimensions's value of the object at the specified index

Throws:

InvalidPacketDataException

getBoardLocationHexMap

public Map<BoardLocation,Hex> getBoardLocationHexMap(int index)
                                              throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Map of BoardLocation key's with Hex value's of the object at the specified index

Throws:

InvalidPacketDataException

getBuildingList

public List<IBuilding> getBuildingList(int index)
                                throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of IBuilding's value of the object at the specified index

Throws:

InvalidPacketDataException

getCoords

@Nullable
public Coords getCoords(int index)
                 throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Coords value of the object at the specified index

Throws:

InvalidPacketDataException

getCoordsHashSet

public HashSet<Coords> getCoordsHashSet(int index)
                                 throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a HashSet of Coords's value of the object at the specified index

Throws:

InvalidPacketDataException

getBoardLocationIntegerMap

public HashMap<BoardLocation,Integer> getBoardLocationIntegerMap(int index)
                                                          throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a HashMap of BoardLocation to Integer at the specified index

Throws:

InvalidPacketDataException

getCoordsVector

public Vector<Coords> getCoordsVector(int index)
                               throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of Coords's value of the object at the specified index

Throws:

InvalidPacketDataException

getCoordsWithGroundObjectListMap

public Map<Coords,List<ICarryable>> getCoordsWithGroundObjectListMap(int index)
                                                              throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Map of Coords key's with a List of GroundObject GroundObject value's of the object at the specified index

Throws:

InvalidPacketDataException

getCoordsWithSpecialHexDisplayCollectionMap

public Map<Coords,Collection<SpecialHexDisplay>> getCoordsWithSpecialHexDisplayCollectionMap(int index)
                                                                                      throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Map of Coords key's with a Collection of SpecialHexDisplay value's of the object at the specified index

Throws:

InvalidPacketDataException

getEntity

@Nullable
public Entity getEntity(int index)
                 throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Entity value of the object at the specified index

Throws:

InvalidPacketDataException

getEntityList

public List<Entity> getEntityList(int index)
                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of Entity's value of the object at the specified index

Throws:

InvalidPacketDataException

getEntityActionList

public List<EntityAction> getEntityActionList(int index)
                                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of EntityAction's value of the object at the specified index

Throws:

InvalidPacketDataException

getFighterSquadron

@Nullable
public FighterSquadron getFighterSquadron(int index)
                                   throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the FighterSquadron value of the object at the specified index

Throws:

InvalidPacketDataException

getFlareVector

public Vector<Flare> getFlareVector(int index)
                             throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of Flare's value of the object at the specified index

Throws:

InvalidPacketDataException

getForce

@Nullable
public Force getForce(int index)
               throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Force value of the object at the specified index or NULL

Throws:

InvalidPacketDataException

getForces

@Nullable
public Forces getForces(int index)
                 throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Forces value of the object at the specified index

Throws:

InvalidPacketDataException

getForceList

public List<Force> getForceList(int index)
                         throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of Force's value of the object at the specified index

Throws:

InvalidPacketDataException

getGameOptions

@Nullable
public GameOptions getGameOptions(int index)
                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the GameOptions value of the object at the specified index

Throws:

InvalidPacketDataException

getGameTurnList

public List<GameTurn> getGameTurnList(int index)
                               throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of GameTurn's value of the object at the specified index

Throws:

InvalidPacketDataException

getHex

@Nullable
public Hex getHex(int index)
           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Hex value of the object at the specified index

Throws:

InvalidPacketDataException

getIBasicOptionVector

public Vector<IBasicOption> getIBasicOptionVector(int index)
                                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of Player's value of the object at the specified index

Throws:

InvalidPacketDataException

getInGameObject

@Nullable
public InGameObject getInGameObject(int index)
                             throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the InGameObject value of the object at the specified index

Throws:

InvalidPacketDataException

getInGameObjectList

public List<InGameObject> getInGameObjectList(int index)
                                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of InGameObject's value of the object at the specified index

Throws:

InvalidPacketDataException

getMapSettings

@Nullable
public MapSettings getMapSettings(int index)
                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the MapSettings value of the object at the specified index

Throws:

InvalidPacketDataException

getMinefield

@Nullable
public Minefield getMinefield(int index)
                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Minefield value of the object at the specified index

Throws:

InvalidPacketDataException

getMinefieldVector

public Vector<Minefield> getMinefieldVector(int index)
                                     throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of Minefield's value of the object at the specified index

Throws:

InvalidPacketDataException

getMovePath

@Nullable
public MovePath getMovePath(int index)
                     throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the MovePath value of the object at the specified index

Throws:

InvalidPacketDataException

getPacketCommand

@Nullable
public PacketCommand getPacketCommand(int index)

Parameters:

index - the index of the desired object

Returns:

the PacketCommand value of the object at the specified index

getPlanetaryConditions

@Nullable
public PlanetaryConditions getPlanetaryConditions(int index)
                                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the PlanetaryConditions value of the object at the specified index

Throws:

InvalidPacketDataException

getPlayer

@Nullable
public Player getPlayer(int index)
                 throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the Player value of the object at the specified index

Throws:

InvalidPacketDataException

getPlayerIDAndListWithBoardLocation

public PlayerIDAndList<BoardLocation> getPlayerIDAndListWithBoardLocation(int index)
                                                                   throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of Player's value of the object at the specified index

Throws:

InvalidPacketDataException

getPlayerVector

public Vector<Player> getPlayerVector(int index)
                               throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of Player's value of the object at the specified index

Throws:

InvalidPacketDataException

getReportList

public List<Report> getReportList(int index)
                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of Report's value of the object at the specified index

Throws:

InvalidPacketDataException

getReportListOfList

public List<List<Report>> getReportListOfList(int index)
                                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of Lists of Report's value of the object at the specified index

Throws:

InvalidPacketDataException

getSBFMovePath

@Nullable
public SBFMovePath getSBFMovePath(int index)
                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the SBFMovePath value of the object at the specified index

Throws:

InvalidPacketDataException

getSBFReportEntryList

public List<SBFReportEntry> getSBFReportEntryList(int index)
                                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of SBFReportEntry's value of the object at the specified index

Throws:

InvalidPacketDataException

getSBFTurnList

public List<SBFTurn> getSBFTurnList(int index)
                             throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of SBFTurn's value of the object at the specified index

Throws:

InvalidPacketDataException

getSmokeCloud

@Nullable
public SmokeCloud getSmokeCloud(int index)
                         throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the SmokeCloud value of the object at the specified index

Throws:

InvalidPacketDataException

getTemporaryECMField

@Nullable
public TemporaryECMField getTemporaryECMField(int index)
                                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the TemporaryECMField value of the object at the specified index

Throws:

InvalidPacketDataException

getSpecialHexDisplay

@Nullable
public SpecialHexDisplay getSpecialHexDisplay(int index)
                                       throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the SpecialHexDisplay value of the object at the specified index

Throws:

InvalidPacketDataException

getTagInfoVector

public Vector<TagInfo> getTagInfoVector(int index)
                                 throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of TagInfo's value of the object at the specified index

Throws:

InvalidPacketDataException

getUnitLocationVector

@Nullable
public Vector<UnitLocation> getUnitLocationVector(int index)
                                           throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a Vector of UnitLocation's value of the object at the specified index

Throws:

InvalidPacketDataException

getWeaponAttackActionList

public List<WeaponAttackAction> getWeaponAttackActionList(int index)
                                                   throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

a List of WeaponAttackAction's value of the object at the specified index

Throws:

InvalidPacketDataException

getWeaponSortOrder

@Nullable
public WeaponSortOrder getWeaponSortOrder(int index)
                                   throws InvalidPacketDataException

Parameters:

index - the index of the desired object

Returns:

the WeaponSortOrder value of the object at the specified index

Throws:

InvalidPacketDataException

toString

@Nonnull
public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.