shared.networking

Interface Serializer

All Known Implementing Classes:

JSONSerializer

public interface Serializer

Method Summary

Modifier and Type	Method and Description
java.lang.String	sAcceptTradeReq(int playerIndex, boolean willAccept) Serializes a request to accept (or reject) a trade
java.lang.String	sAddAIReq(AIType aitype) Serializes a request to add AI to a game
java.lang.String	sBuildCityReq(int playerIndex, VertexLocation vertexLocation) Serializes a request to build a city
java.lang.String	sBuildRoadReq(int playerIndex, EdgeLocation roadLocation, boolean free) Serializes a request to build a road
java.lang.String	sBuildSettlementReq(int playerIndex, VertexLocation vertexLocation, boolean free) Serializes a request to build a settlement
java.lang.String	sBuyDevCardReq(int playerIndex) Serializes a request to buy a development card
java.lang.String	sCreateGameReq(boolean randomTiles, boolean randomNumbers, boolean randomPorts, java.lang.String name) Serializes data for requests to create a game
java.lang.String	sCredentials(java.lang.String username, java.lang.String password) Serializes the information for any requests that require user credentials
java.lang.String	sDiscardCardsReq(int playerIndex, java.util.List<java.lang.Integer> resourceList) Serializes a request to discard cards
java.lang.String	sFinishTurnReq(int playerIndex) Serializes a request to finish a turn
java.lang.String	sJoinGameReq(int id, CatanColor color) Serializes a request from a user to join a game
java.lang.String	sMaritimeTradeReq(int playerIndex, int ratio, ResourceType inputResource, ResourceType outputResource) Serializes a request to perform a maritime trade
java.lang.String	sMonopolyCardReq(int playerIndex, ResourceType resource) Serializes a request to play a monopoly card
java.lang.String	sMonumentCardReq(int playerIndex) Serializes a request to play a monument card
java.lang.String	sOfferTradeReq(int playerIndex, java.util.List<java.lang.Integer> resourceList, int receiver) Serializes a request to offer a trade
java.lang.String	sRoadBuildingCardReq(int playerIndex, EdgeLocation edgeLoc1, EdgeLocation edgeLoc2) Serializes a request to play a road building card
java.lang.String	sRobPlayerReq(int playerIndex, int victimIndex, HexLocation location) Serializes a request to rob a player
java.lang.String	sRollNumberReq(int playerIndex, int number) Serializes a request to roll a dice, where the result is already known
java.lang.String	sSendChatReq(int playerIndex, java.lang.String content) Serializes a request to send a chat message
java.lang.String	sSoldierCardReq(int playerIndex, int victimIndex, HexLocation location) Serializes a request to play a soldier card
java.lang.String	sYearOfPlentyCardReq(int playerIndex, ResourceType resource1, ResourceType resource2) Serializes a request to play a Year of Plenty card

Method Detail

sCredentials

java.lang.String sCredentials(java.lang.String username,
                              java.lang.String password)
                       throws java.lang.Exception

Serializes the information for any requests that require user credentials

Parameters:

username - The user's username

password - The user's password

Returns:

Serialized data

Throws:

java.lang.Exception

sCreateGameReq

java.lang.String sCreateGameReq(boolean randomTiles,
                                boolean randomNumbers,
                                boolean randomPorts,
                                java.lang.String name)
                         throws java.lang.Exception

Serializes data for requests to create a game

Parameters:

randomTiles - Whether to create a game with random tiles

randomNumbers - Whether to create a game with random chit placement

randomPorts - Whether to create a game with random ports

name - The name of the game to create

Returns:

Serialized data

Throws:

java.lang.Exception

sJoinGameReq

java.lang.String sJoinGameReq(int id,
                              CatanColor color)
                       throws java.lang.Exception

Serializes a request from a user to join a game

Parameters:

id - ID of the user who wishes to join the game

color - The color the user requests

Returns:

Serialized data

Throws:

java.lang.Exception

sAddAIReq

java.lang.String sAddAIReq(AIType aitype)
                    throws java.lang.Exception

Serializes a request to add AI to a game

Parameters:

AIType - The type of AI to add to the game

Returns:

Serialized data

Throws:

java.lang.Exception

sSendChatReq

java.lang.String sSendChatReq(int playerIndex,
                              java.lang.String content)
                       throws java.lang.Exception

Serializes a request to send a chat message

Parameters:

playerIndex - The index of the player sending the chat

content - The chat content

Returns:

Serialized data

Throws:

java.lang.Exception

sRollNumberReq

java.lang.String sRollNumberReq(int playerIndex,
                                int number)
                         throws java.lang.Exception

Serializes a request to roll a dice, where the result is already known

Parameters:

playerIndex - The index of the player who rolls

number - The number rolled

Returns:

Serialized data

Throws:

java.lang.Exception

sRobPlayerReq

java.lang.String sRobPlayerReq(int playerIndex,
                               int victimIndex,
                               HexLocation location)
                        throws java.lang.Exception

Serializes a request to rob a player

Parameters:

playerIndex - The index of the player doing the robbing

victimIndex - The index of the victim

location - The new location of the robber

Returns:

Serialized data

Throws:

java.lang.Exception

sFinishTurnReq

java.lang.String sFinishTurnReq(int playerIndex)
                         throws java.lang.Exception

Serializes a request to finish a turn

Parameters:

playerIndex - The index of the player who is finishing their turn

Returns:

Serialized data

Throws:

java.lang.Exception

sBuyDevCardReq

java.lang.String sBuyDevCardReq(int playerIndex)
                         throws java.lang.Exception

Serializes a request to buy a development card

Parameters:

playerIndex - The index of the player who is buying the development card

Returns:

Serialized data

Throws:

java.lang.Exception

sYearOfPlentyCardReq

java.lang.String sYearOfPlentyCardReq(int playerIndex,
                                      ResourceType resource1,
                                      ResourceType resource2)
                               throws java.lang.Exception

Serializes a request to play a Year of Plenty card

Parameters:

playerIndex - The index of the player who wishes to play the card

resource1 - The first resource to take from the bank

resource2 - The second resource to take from the bank

Returns:

Serialized data

Throws:

java.lang.Exception

sRoadBuildingCardReq

java.lang.String sRoadBuildingCardReq(int playerIndex,
                                      EdgeLocation edgeLoc1,
                                      EdgeLocation edgeLoc2)
                               throws java.lang.Exception

Serializes a request to play a road building card

Parameters:

playerIndex - The index of the player who wishes to play the card

edgeLoc1 - The location of the first road

edgeLoc2 - The location of the second road

Returns:

Serialized data

Throws:

java.lang.Exception

sSoldierCardReq

java.lang.String sSoldierCardReq(int playerIndex,
                                 int victimIndex,
                                 HexLocation location)
                          throws java.lang.Exception

Serializes a request to play a soldier card

Parameters:

playerIndex - The index of the player who wishes to play the card

victimIndex - The index of the victim

location - The new hex location of the soldier

Returns:

Serialized data

Throws:

java.lang.Exception

sMonopolyCardReq

java.lang.String sMonopolyCardReq(int playerIndex,
                                  ResourceType resource)
                           throws java.lang.Exception

Serializes a request to play a monopoly card

Parameters:

playerIndex - The index of the player who wishes to play the card

resource - The resource to have a monopoly on

Returns:

Serialized data

Throws:

java.lang.Exception

sMonumentCardReq

java.lang.String sMonumentCardReq(int playerIndex)
                           throws java.lang.Exception

Serializes a request to play a monument card

Parameters:

playerIndex - The index of the player who wishes to play the card

Returns:

Serialized data

Throws:

java.lang.Exception

sBuildRoadReq

java.lang.String sBuildRoadReq(int playerIndex,
                               EdgeLocation roadLocation,
                               boolean free)
                        throws java.lang.Exception

Serializes a request to build a road

Parameters:

playerIndex - The index of the player who wishes to build the road

roadLocation - The location of the road

free - Whether this road is free (doesn't cost resources) or not

Returns:

Serialized data

Throws:

java.lang.Exception

sBuildSettlementReq

java.lang.String sBuildSettlementReq(int playerIndex,
                                     VertexLocation vertexLocation,
                                     boolean free)
                              throws java.lang.Exception

Serializes a request to build a settlement

Parameters:

playerIndex - The index of the player who wishes to build the settlement

vertexLocation - Where to build the settlement

free - Whether this settlement is free (doesn't cost resources) or not

Returns:

Serialized data

Throws:

java.lang.Exception

sBuildCityReq

java.lang.String sBuildCityReq(int playerIndex,
                               VertexLocation vertexLocation)
                        throws java.lang.Exception

Serializes a request to build a city

Parameters:

playerIndex - The index of the player who wishes to build the city

vertexLocation - Where to build the city

Returns:

Serialized data

Throws:

java.lang.Exception

sOfferTradeReq

java.lang.String sOfferTradeReq(int playerIndex,
                                java.util.List<java.lang.Integer> resourceList,
                                int receiver)
                         throws java.lang.Exception

Serializes a request to offer a trade

Parameters:

playerIndex - The index of the player offering the trade

resourceList - The list of resources being traded and asked for

receiver - The index of the receiver

Returns:

Serialized data

Throws:

java.lang.Exception

sAcceptTradeReq

java.lang.String sAcceptTradeReq(int playerIndex,
                                 boolean willAccept)
                          throws java.lang.Exception

Serializes a request to accept (or reject) a trade

Parameters:

playerIndex - The index of the player who is accepting or rejecting the trade

willAccept - Whether the trade is accepted

Returns:

Serialized data

Throws:

java.lang.Exception

sMaritimeTradeReq

java.lang.String sMaritimeTradeReq(int playerIndex,
                                   int ratio,
                                   ResourceType inputResource,
                                   ResourceType outputResource)
                            throws java.lang.Exception

Serializes a request to perform a maritime trade

Parameters:

playerIndex - The index of the player who is performing the trade

ratio - The trade ratio of the port

inputResource - The resource being traded

outputResource - The resource being traded for

Returns:

Serialized data

Throws:

java.lang.Exception

sDiscardCardsReq

java.lang.String sDiscardCardsReq(int playerIndex,
                                  java.util.List<java.lang.Integer> resourceList)
                           throws java.lang.Exception

Serializes a request to discard cards

Parameters:

playerIndex - The index of the player discarding cards

resourceList - A resource list with the cards being discarded

Returns:

Serialized data

Throws:

java.lang.Exception