diff options
Diffstat (limited to 'src/jrummikub/view/IGameListPanel.java')
-rw-r--r-- | src/jrummikub/view/IGameListPanel.java | 73 |
1 files changed, 37 insertions, 36 deletions
diff --git a/src/jrummikub/view/IGameListPanel.java b/src/jrummikub/view/IGameListPanel.java index cb77cdc..51d6616 100644 --- a/src/jrummikub/view/IGameListPanel.java +++ b/src/jrummikub/view/IGameListPanel.java @@ -1,54 +1,55 @@ package jrummikub.view; -import java.util.UUID; - -import jrummikub.model.GameSettings; +import jrummikub.util.GameData; import jrummikub.util.IEvent; import jrummikub.util.IEvent1; +/** + * Panel showing all offered games in the chosen channel + */ public interface IGameListPanel { - public static class GameData { - private UUID gameID; - private String host; - private GameSettings gameSettings; - - public GameData(UUID gameID, GameSettings settings) { - this(gameID, settings, null); - } - - public GameData(UUID gameID, GameSettings settings, String host) { - this.gameID = gameID; - this.gameSettings = settings; - this.host = host; - - } - - public void setGameSettings(GameSettings settings) { - gameSettings = settings; - } - - public GameSettings getGameSettings() { - return gameSettings; - } - - public String getHost() { - return host; - } - - public UUID getGameID() { - return gameID; - } - } - + /** + * Emitted when a new game is offered + * + * @return the event + */ public IEvent getOpenNewGameEvent(); + /** + * Emitted when the network game is canceled + * + * @return the event + */ public IEvent getCancelEvent(); + /** + * Emitted when the user chose to join an existing, open game + * + * @return the event + */ public IEvent1<GameData> getJoinEvent(); + /** + * Emitted when an open game is removed by the host + * + * @param game + * game data of the open game + */ public void removeGame(GameData game); + /** + * Adds a game to the list of open games + * + * @param game + * game data of the new game + */ public void addGame(GameData game); + /** + * Sets the channel name + * + * @param name + * channel name + */ public void setChannelName(String name); } |