edu.illinois.cs.cs125.spring2020.mp.logic

Class GameSummary

java.lang.Object

edu.illinois.cs.cs125.spring2020.mp.logic.GameSummary

public class GameSummary
extends java.lang.Object

Extracts summary information about a game from JSON provided by the server.

One GameSummary instance corresponds to one object from the games array in the response from the server's /games endpoint.

Constructor Summary

Constructors

Constructor and Description
GameSummary(com.google.gson.JsonObject infoFromServer) Creates a game summary from JSON from the server.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Gets the unique, server-assigned ID of this game.
java.lang.String	getMode() Gets the mode of this game, either area or target.
java.lang.String	getOwner() Gets the owner/creator of this game.
java.lang.String	getPlayerRole(java.lang.String userEmail, android.content.Context context) Gets the name of the user's team/role.
boolean	isInvitation(java.lang.String userEmail) Determines whether this game is an invitation to the user.
boolean	isOngoing(java.lang.String userEmail) Determines whether the user is currently involved in this game.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameSummary

public GameSummary(com.google.gson.JsonObject infoFromServer)

Creates a game summary from JSON from the server.

Parameters:

infoFromServer - one object from the array in the /games response

Method Detail

getId

public java.lang.String getId()

Gets the unique, server-assigned ID of this game.

Returns:

the game ID

getMode

public java.lang.String getMode()

Gets the mode of this game, either area or target.

Returns:

the game mode

getOwner

public java.lang.String getOwner()

Gets the owner/creator of this game.

Returns:

the email of the game's owner

getPlayerRole

public java.lang.String getPlayerRole(java.lang.String userEmail,
                                      android.content.Context context)

Gets the name of the user's team/role.

Parameters:

userEmail - the logged-in user's email

context - an Android context (for access to resources)

Returns:

the human-readable team/role name of the user in this game

isInvitation

public boolean isInvitation(java.lang.String userEmail)

Determines whether this game is an invitation to the user.

Parameters:

userEmail - the logged-in user's email

Returns:

whether the user is invited to this game

isOngoing

public boolean isOngoing(java.lang.String userEmail)

Determines whether the user is currently involved in this game.

For a game to be ongoing, it must not be over and the user must have accepted their invitation to it.

Parameters:

userEmail - the logged-in user's email

Returns:

whether this game is ongoing for the user