From f5a05f2c8d42b9f5978d8118c065fa8a871ec2fd Mon Sep 17 00:00:00 2001
From: Ida Massow <massow@informatik.uni-luebeck.de>
Date: Mon, 13 Jun 2011 23:31:47 +0200
Subject: Kommentare und kleinere Umbauten

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@426 72836036-5685-4462-b002-a69064685172
---
 src/jrummikub/view/IGameListPanel.java | 73 +++++++++++++++++-----------------
 1 file changed, 37 insertions(+), 36 deletions(-)

(limited to 'src/jrummikub/view/IGameListPanel.java')

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);
 }
-- 
cgit v1.2.3