com.socialquantum.battleship.gameapi.types.connector

Interface GameConnector

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

GameConnectionVer1

public interface GameConnector
extends java.io.Closeable

!NB! Возвращаемый тип каждого метода должен быть GeneralOperationResponse + описание того что может быть возвращено Основоной интерфейс взаимодействия с игрой. Большинство методов интерфейса предполагают возврат обобщенных данных Created 27/06/17 16:40

Since:

version 1 GameConnector

Method Summary

Modifier and Type	Method and Description
CreateGame	createGame(UserToken player1Token, UserToken player2Token) Создать игру.
DeleteGame	deleteGame(GameId gameId) Удалить игру.
DeleteSnapshot	deleteSnapshot(SnapshotId snapshotId) Удалить сохраненное состояние.
GameList	gameList() Получить список всех игр для игрока
GameStatus	gameStatus(GameId gameId) Получить текущий статус игры.
PlaceShips	placeShips(ShipsPlacementRequest shipsPlacement) Расположить корабли.
RestoreSnapshot	restoreSnapshot(SnapshotId snapshotId) Восстановить состояние игры.
SaveSnapshot	saveSnapshoot(GameId gameId) Сохранить состояние игры.
Shoot	shoot(GameId gameId, int x, int y) Осуществить выстрел.
SnapshotList	snapshotList() Получить список всех сохраненных состояний
StartGame	startGame(GameId gameId) Начать игру.

Methods inherited from interface java.io.Closeable

close

Method Detail

createGame

CreateGame createGame(UserToken player1Token,
                      UserToken player2Token)

Создать игру.

Parameters:

player1Token - токен первого игрока

player2Token - токен второго игрока

Returns:

Результат выполнения операции

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

startGame

StartGame startGame(GameId gameId)

Начать игру.

Parameters:

gameId - идентификатор игры

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

deleteGame

DeleteGame deleteGame(GameId gameId)

Удалить игру.

Parameters:

gameId - идентфиикатор игры

Returns:

Результат выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

gameList

GameList gameList()

Получить список всех игр для игрока

Returns:

Результат выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

gameStatus

GameStatus gameStatus(GameId gameId)

Получить текущий статус игры.

Parameters:

gameId - идентфиикатор игры.

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

placeShips

PlaceShips placeShips(ShipsPlacementRequest shipsPlacement)

Расположить корабли.

Parameters:

shipsPlacement - - объект расположения данных о кораблях

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

shoot

Shoot shoot(GameId gameId,
            int x,
            int y)

Осуществить выстрел.

Parameters:

gameId - - идентфикатор игры

x - - координата x

y - - координата y

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

saveSnapshoot

SaveSnapshot saveSnapshoot(GameId gameId)

Сохранить состояние игры.

Parameters:

gameId - идентификатор игры

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

restoreSnapshot

RestoreSnapshot restoreSnapshot(SnapshotId snapshotId)

Восстановить состояние игры.

Parameters:

snapshotId - идентфиикатор состояния.

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

snapshotList

SnapshotList snapshotList()

Получить список всех сохраненных состояний

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1

deleteSnapshot

DeleteSnapshot deleteSnapshot(SnapshotId snapshotId)

Удалить сохраненное состояние.

Parameters:

snapshotId - идентфиикатор сохраенных данных

Returns:

Объект результата выполненной команды

Throws:

OperationFailed - в случае неуспешной операции

Since:

version 1