GameConnector (library 1.0 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

GameConnectionVer1
```
public interface GameConnector
extends java.io.Closeable
```
Основоной интерфейс взаимодействия с игрой. Большинство методов интерфейса предполагают возврат обобщенных данных результата выполнения команды взаимодействия. Конкретный тип возвращаемого объекта для случаем успеха и не успеха операции указаны в описании каждого метода. Приведение к желаемому типу можно делать как стандартными средствами языка (ResultType) result, так и с использованием метода cast(Object, Class) определенного в этом интерфейсе.
Created 27/06/17 16:40

Since:

version 0.9 GameConnector

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static <T> T`	`cast(java.lang.Object o, java.lang.Class<T> clazz)` Вспомогательный метод приведения объекта к требуемому типу По сути является, компактной записью для (SomeType) object, при этом если объект не является типом, к которому производится приведение, в отличии от стандартного `ClassCastException`, будет выброшено исключение `UnexpectedOperationResult` как это происходит в случае приведения средствами языка.
`OperationResponse`	`createGame(UserToken player1Token, UserToken player2Token)` Создать игру.
`OperationResponse`	`deleteGame(GameId gameId)` Удалить игру.
`OperationResponse`	`deleteSnapshot(SnapshotId snapshotId)` Удалить сохраненное состояние.
`OperationResponse`	`gameList()` Получить список всех игр для игрока Типы возвращаемые в случае успеха и не успеха операции соответственно: `GameList` `OperationError`
`OperationResponse`	`gameStatus(GameId gameId)` Получить текущий статус игры.
`OperationResponse`	`placeShips(ShipsPlacementRequest shipsPlacement)` Расположить корабли.
`OperationResponse`	`restoreSnapshot(SnapshotId snapshotId)` Восстановить состояние игры.
`OperationResponse`	`saveSnapshoot(GameId gameId)` Сохранить состояние игры.
`OperationResponse`	`shoot(GameId gameId, int x, int y)` Выстрел.
`void`	`shut()` Закрытие коннектора, освобождение ресурсов.
`OperationResponse`	`snapshotList()` Получить список всех сохраненных состояний Типы возвращаемые в случае успеха и не успеха операции соответственно: `SnapshotList` `OperationError`
`OperationResponse`	`startGame(GameId gameId)` Начать игру.

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - createGame
```
OperationResponse createGame(UserToken player1Token,
                             UserToken player2Token)
```
    Создать игру. Типы возвращаемые в случае успеха и не успеха операции соответственно: CreateGame OperationError
    
    Parameters:
    
    player1Token - токен первого игрока
    
    player2Token - токен второго игрока
    
    Returns:
    
    Результат выполнения операции
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - startGame
```
OperationResponse startGame(GameId gameId)
```
    Начать игру. Типы возвращаемые в случае успеха и не успеха операции соответственно: StartGame OperationError
    
    Parameters:
    
    gameId - идентификатор игры
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - deleteGame
```
OperationResponse deleteGame(GameId gameId)
```
    Удалить игру. Типы возвращаемые в случае успеха и не успеха операции соответственно: DeleteGame OperationError
    
    Parameters:
    
    gameId - идентфиикатор игры
    
    Returns:
    
    Результат выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - gameList
```
OperationResponse gameList()
```
    Получить список всех игр для игрока Типы возвращаемые в случае успеха и не успеха операции соответственно: GameList OperationError
    
    Returns:
    
    Результат выполненной команды
    
    Since:
    
    version 0.9
  - gameStatus
```
OperationResponse gameStatus(GameId gameId)
```
    Получить текущий статус игры.
    Типы возвращаемые в случае успеха и не успеха операции соответственно: GameStatus OperationError
    
    Parameters:
    
    gameId - идентфиикатор игры.
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - placeShips
```
OperationResponse placeShips(ShipsPlacementRequest shipsPlacement)
```
    Расположить корабли. Типы возвращаемые в случае успеха и не успеха операции соответственно: PlaceShips OperationError
    
    Parameters:
    
    shipsPlacement - - объект расположения данных о кораблях
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - shoot
```
OperationResponse shoot(GameId gameId,
                        int x,
                        int y)
```
    Выстрел. Типы возвращаемые в случае успеха и не успеха операции соответственно: Shoot OperationError
    
    Parameters:
    
    gameId - - идентфикатор игры
    
    x - - координата x
    
    y - - координата y
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - saveSnapshoot
```
OperationResponse saveSnapshoot(GameId gameId)
```
    Сохранить состояние игры. Типы возвращаемые в случае успеха и не успеха операции соответственно: SaveSnapshot OperationError
    
    Parameters:
    
    gameId - идентификатор игры
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - restoreSnapshot
```
OperationResponse restoreSnapshot(SnapshotId snapshotId)
```
    Восстановить состояние игры. Типы возвращаемые в случае успеха и не успеха операции соответственно: RestoreSnapshot OperationError
    
    Parameters:
    
    snapshotId - идентфиикатор состояния.
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - snapshotList
```
OperationResponse snapshotList()
```
    Получить список всех сохраненных состояний Типы возвращаемые в случае успеха и не успеха операции соответственно: SnapshotList OperationError
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - deleteSnapshot
```
OperationResponse deleteSnapshot(SnapshotId snapshotId)
```
    Удалить сохраненное состояние. Типы возвращаемые в случае успеха и не успеха операции соответственно: DeleteSnapshot OperationError
    
    Parameters:
    
    snapshotId - идентфиикатор сохраенных данных
    
    Returns:
    
    Объект результата выполненной команды
    
    Since:
    
    version 0.9
    
    See Also:
    
    cast(Object, Class)
  - shut
```
void shut()
   throws java.io.IOException
```
    Закрытие коннектора, освобождение ресурсов. После закрытия коннектора более нельзя использовать ни один из его методов
    
    Throws:
    
    java.io.IOException
  - cast
```
static <T> T cast(java.lang.Object o,
                  java.lang.Class<T> clazz)
```
    Вспомогательный метод приведения объекта к требуемому типу По сути является, компактной записью для (SomeType) object, при этом если объект не является типом, к которому производится приведение, в отличии от стандартного ClassCastException, будет выброшено исключение UnexpectedOperationResult как это происходит в случае приведения средствами языка.
    
    Type Parameters:
    
    T - приводимый тип
    
    Parameters:
    
    o - объект
    
    clazz - приводимый тип
    
    Returns:
    
    объект, приведенный к типу
    
    Throws:
    
    UnexpectedOperationResult - в случае попытки приведения к неверному типу

Interface GameConnector

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

createGame

startGame

deleteGame

gameList

gameStatus

placeShips

shoot

saveSnapshoot

restoreSnapshot

snapshotList

deleteSnapshot

shut

cast