shared.networking

Class JSONSerializer

java.lang.Object

shared.networking.JSONSerializer

All Implemented Interfaces:

Serializer

public class JSONSerializer
extends java.lang.Object
implements Serializer

Author:

pbridd

Constructor Summary

Constructors

Constructor and Description
JSONSerializer()

Method Summary

Modifier and Type	Method and Description
private org.json.JSONObject	oEdgeLocation(EdgeLocation edgeLocation)
private org.json.JSONObject	oHexLocation(HexLocation location)
private org.json.JSONObject	oResourceList(java.util.List<java.lang.Integer> resourceList) Turns the passed resource list into a JSONObject which is returned
private org.json.JSONObject	oVertexLocation(VertexLocation vertexLocation)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONSerializer

public JSONSerializer()

Method Detail

sCredentials

public java.lang.String sCredentials(java.lang.String username,
                                     java.lang.String password)
                              throws org.json.JSONException

Description copied from interface: Serializer

Serializes the information for any requests that require user credentials

Specified by:

sCredentials in interface Serializer

Parameters:

username - The user's username

password - The user's password

Returns:

Serialized data

Throws:

org.json.JSONException

sCreateGameReq

public java.lang.String sCreateGameReq(boolean randomTiles,
                                       boolean randomNumbers,
                                       boolean randomPorts,
                                       java.lang.String name)
                                throws org.json.JSONException

Description copied from interface: Serializer

Serializes data for requests to create a game

Specified by:

sCreateGameReq in interface Serializer

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:

org.json.JSONException

sJoinGameReq

public java.lang.String sJoinGameReq(int id,
                                     CatanColor color)
                              throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request from a user to join a game

Specified by:

sJoinGameReq in interface Serializer

Parameters:

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

color - The color the user requests

Returns:

Serialized data

Throws:

org.json.JSONException

sAddAIReq

public java.lang.String sAddAIReq(AIType aitype)
                           throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to add AI to a game

Specified by:

sAddAIReq in interface Serializer

Returns:

Serialized data

Throws:

org.json.JSONException

sSendChatReq

public java.lang.String sSendChatReq(int playerIndex,
                                     java.lang.String content)
                              throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to send a chat message

Specified by:

sSendChatReq in interface Serializer

Parameters:

playerIndex - The index of the player sending the chat

content - The chat content

Returns:

Serialized data

Throws:

org.json.JSONException

sRollNumberReq

public java.lang.String sRollNumberReq(int playerIndex,
                                       int number)
                                throws org.json.JSONException

Description copied from interface: Serializer

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

Specified by:

sRollNumberReq in interface Serializer

Parameters:

playerIndex - The index of the player who rolls

number - The number rolled

Returns:

Serialized data

Throws:

org.json.JSONException

sRobPlayerReq

public java.lang.String sRobPlayerReq(int playerIndex,
                                      int victimIndex,
                                      HexLocation location)
                               throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to rob a player

Specified by:

sRobPlayerReq in interface Serializer

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:

org.json.JSONException

oHexLocation

private org.json.JSONObject oHexLocation(HexLocation location)
                                  throws org.json.JSONException

Throws:

org.json.JSONException

sFinishTurnReq

public java.lang.String sFinishTurnReq(int playerIndex)
                                throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to finish a turn

Specified by:

sFinishTurnReq in interface Serializer

Parameters:

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

Returns:

Serialized data

Throws:

org.json.JSONException

sBuyDevCardReq

public java.lang.String sBuyDevCardReq(int playerIndex)
                                throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to buy a development card

Specified by:

sBuyDevCardReq in interface Serializer

Parameters:

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

Returns:

Serialized data

Throws:

org.json.JSONException

sYearOfPlentyCardReq

public java.lang.String sYearOfPlentyCardReq(int playerIndex,
                                             ResourceType resource1,
                                             ResourceType resource2)
                                      throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to play a Year of Plenty card

Specified by:

sYearOfPlentyCardReq in interface Serializer

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:

org.json.JSONException

sRoadBuildingCardReq

public java.lang.String sRoadBuildingCardReq(int playerIndex,
                                             EdgeLocation edgeLoc1,
                                             EdgeLocation edgeLoc2)
                                      throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to play a road building card

Specified by:

sRoadBuildingCardReq in interface Serializer

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:

org.json.JSONException

oEdgeLocation

private org.json.JSONObject oEdgeLocation(EdgeLocation edgeLocation)
                                   throws org.json.JSONException

Throws:

org.json.JSONException

sSoldierCardReq

public java.lang.String sSoldierCardReq(int playerIndex,
                                        int victimIndex,
                                        HexLocation location)
                                 throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to play a soldier card

Specified by:

sSoldierCardReq in interface Serializer

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:

org.json.JSONException

sMonopolyCardReq

public java.lang.String sMonopolyCardReq(int playerIndex,
                                         ResourceType resource)
                                  throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to play a monopoly card

Specified by:

sMonopolyCardReq in interface Serializer

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:

org.json.JSONException

sMonumentCardReq

public java.lang.String sMonumentCardReq(int playerIndex)
                                  throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to play a monument card

Specified by:

sMonumentCardReq in interface Serializer

Parameters:

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

Returns:

Serialized data

Throws:

org.json.JSONException

sBuildRoadReq

public java.lang.String sBuildRoadReq(int playerIndex,
                                      EdgeLocation roadLocation,
                                      boolean free)
                               throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to build a road

Specified by:

sBuildRoadReq in interface Serializer

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:

org.json.JSONException

sBuildSettlementReq

public java.lang.String sBuildSettlementReq(int playerIndex,
                                            VertexLocation vertexLocation,
                                            boolean free)
                                     throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to build a settlement

Specified by:

sBuildSettlementReq in interface Serializer

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:

org.json.JSONException

oVertexLocation

private org.json.JSONObject oVertexLocation(VertexLocation vertexLocation)
                                     throws org.json.JSONException

Throws:

org.json.JSONException

sBuildCityReq

public java.lang.String sBuildCityReq(int playerIndex,
                                      VertexLocation vertexLocation)
                               throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to build a city

Specified by:

sBuildCityReq in interface Serializer

Parameters:

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

vertexLocation - Where to build the city

Returns:

Serialized data

Throws:

org.json.JSONException

sOfferTradeReq

public java.lang.String sOfferTradeReq(int playerIndex,
                                       java.util.List<java.lang.Integer> resourceList,
                                       int receiver)
                                throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to offer a trade

Specified by:

sOfferTradeReq in interface Serializer

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:

org.json.JSONException

oResourceList

private org.json.JSONObject oResourceList(java.util.List<java.lang.Integer> resourceList)
                                   throws org.json.JSONException

Turns the passed resource list into a JSONObject which is returned

Parameters:

resourceList -

Returns:

Throws:

org.json.JSONException

sAcceptTradeReq

public java.lang.String sAcceptTradeReq(int playerIndex,
                                        boolean willAccept)
                                 throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to accept (or reject) a trade

Specified by:

sAcceptTradeReq in interface Serializer

Parameters:

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

willAccept - Whether the trade is accepted

Returns:

Serialized data

Throws:

org.json.JSONException

sMaritimeTradeReq

public java.lang.String sMaritimeTradeReq(int playerIndex,
                                          int ratio,
                                          ResourceType inputResource,
                                          ResourceType outputResource)
                                   throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to perform a maritime trade

Specified by:

sMaritimeTradeReq in interface Serializer

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:

org.json.JSONException

sDiscardCardsReq

public java.lang.String sDiscardCardsReq(int playerIndex,
                                         java.util.List<java.lang.Integer> resourceList)
                                  throws org.json.JSONException

Description copied from interface: Serializer

Serializes a request to discard cards

Specified by:

sDiscardCardsReq in interface Serializer

Parameters:

playerIndex - The index of the player discarding cards

resourceList - A resource list with the cards being discarded

Returns:

Serialized data

Throws:

org.json.JSONException