View Javadoc

1   // START LICENSE
2   // JSet - a Java JSet card board game implementation
3   // Copyright (C) 2004 Jerome Lacoste
4   //
5   // This program is free software; you can redistribute it and/or modify
6   // it under the terms of the GNU General Public License as published by
7   // the Free Software Foundation; either version 2 of the License, or (at
8   // your option) any later version.
9   //
10  // This program is distributed in the hope that it will be useful, but
11  // WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // General Public License for more details.
14  //
15  // You should have received a copy of the GNU General Public License
16  // along with this program; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  // END LICENSE
19  
20  package org.cb.jset;
21  
22  /***
23   * An interface for a game connection.
24   *<p>
25   * GameConnection instances are delivered to a {@link SetGamePlayer} holder by a {@link SetGame} in order for the player
26   * to perform operations.
27   *
28   * @author jerome@coffeebreaks.org - last modified by $LastChangedBy: jerome $
29   * @version $Id: SetGameConnection.java 117 2004-04-14 23:16:04Z jerome $
30   */
31  public interface SetGameConnection
32  {
33    /***
34     * Used by a registered player to try to match a set of cards.
35     * @param set the set to try to match.
36     * @throws MatchingException if the set doesn't match or if a card is not on the board.
37     */
38    void matchSet(CardSet set) throws MatchingException;
39  
40    /***
41     * Close the game connection, effectively leaving the game.
42     */
43    void close();
44  
45    /***
46     * Say wether the game connection is closed or not.
47     * @return <code>true</code> if the connection is closed, <code>false</code> otherwise.
48     */
49    boolean isClosed();
50  }