vooga.network
Class VoogaUserGrouping

java.lang.Object
  extended by vooga.network.VoogaUserGrouping
Direct Known Subclasses:
VoogaLobby

public class VoogaUserGrouping
extends java.lang.Object

VoogaUserGrouping defines a collection of users, such as a chat room, a game session, or a game lobby.

Author:
tgr3, tws10, sam1

Field Summary
(package private)  java.util.Set<java.lang.String> myOccupants
           
 
Constructor Summary
VoogaUserGrouping()
          Creates myOccupants, a HashSet of users
 
Method Summary
 void addUser(java.lang.String userName)
           
 java.util.Set<java.lang.String> getOccupants()
           
 boolean isEmpty()
           
 void removeUser(java.lang.String userName)
           
protected  void setOccupants(java.util.Set<java.lang.String> occupants)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

myOccupants

java.util.Set<java.lang.String> myOccupants
Constructor Detail

VoogaUserGrouping

public VoogaUserGrouping()
Creates myOccupants, a HashSet of users

Method Detail

addUser

public void addUser(java.lang.String userName)
Parameters:
userName - to be added to grouping

getOccupants

public java.util.Set<java.lang.String> getOccupants()
Returns:
HashSet copy of grouping occupants

setOccupants

protected void setOccupants(java.util.Set<java.lang.String> occupants)

isEmpty

public boolean isEmpty()
Returns:
true if grouping is empty

removeUser

public void removeUser(java.lang.String userName)
Parameters:
userName - to be removed from grouping