org.moock.unity.core
Class RoomDefinition

java.lang.Object
  |
  +--org.moock.unity.core.RoomModel
        |
        +--org.moock.unity.core.RoomDefinition

public class RoomDefinition
extends org.moock.unity.core.RoomModel

Defines the makeup of a room when creating new rooms.

Author:
Derek Clayton

Field Summary
static int AUTHENTICATION
           
static int NO_AUTHENTICATION
           
 
Constructor Summary
RoomDefinition()
           
RoomDefinition(java.lang.String roomType, java.lang.String roomID)
           
RoomDefinition(java.lang.String roomType, java.lang.String roomID, java.lang.String namespace)
           
 
Method Summary
 java.util.ArrayList getAttributes()
          Set the attributes for the room.
 int getAuthentication()
          Get the authentication for the room.
 java.util.ArrayList getIPAuthorizedList()
          Deprecated. no longer used by the server developers using this should maintain the list in an Attribute
 java.lang.String getNamespace()
          Gets the namespace this room is associated with.
 java.lang.String getOwnerID()
           
 java.lang.String getRoomID()
          Set the ID of the Room.
 java.lang.String getRoomType()
          Gets the type of Room as defined in RoomTypes.xml.
 boolean isAutojoin()
          Returns true if clients are set to join the Room when they connect to the server.
 boolean isDieOnEmpty()
          Returns true if the Room should die when the last Client leaves, false otherwise.
 void setAttribute(org.moock.unity.core.Attribute attribute)
          Set the attributes for the room.
 void setAuthentication(int authentication)
          Sets the authentication for the room.
 void setAutojoin(boolean setter)
          Set to true if the clients are set to join the Room when they connect to the server.
 void setDieOnEmpty(boolean die)
          Set to true if the Room should die when the last Client leaves, false otherwise.
 void setIPAuthorizedList(java.util.ArrayList list)
          Deprecated. no longer used by the server developers using this should maintain the list in an Attribute
 void setNamespace(java.lang.String namespace)
          Sets the parent room ID.
 void setOwnerID(java.lang.String id)
           
 void setRoomID(java.lang.String setter)
          Get the ID of the Room.
 void setRoomType(java.lang.String setter)
          Sets the type of Room as defined in RoomTypes.xml.
 
Methods inherited from class org.moock.unity.core.RoomModel
getMaxClients, getTimeout, isAcceptOutsideMessages, setAcceptOutsideMessages, setMaxClients
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_AUTHENTICATION

public static final int NO_AUTHENTICATION

AUTHENTICATION

public static final int AUTHENTICATION
Constructor Detail

RoomDefinition

public RoomDefinition()

RoomDefinition

public RoomDefinition(java.lang.String roomType,
                      java.lang.String roomID)

RoomDefinition

public RoomDefinition(java.lang.String roomType,
                      java.lang.String roomID,
                      java.lang.String namespace)
Method Detail

setOwnerID

public void setOwnerID(java.lang.String id)

getOwnerID

public java.lang.String getOwnerID()

setIPAuthorizedList

public void setIPAuthorizedList(java.util.ArrayList list)
Deprecated. no longer used by the server developers using this should maintain the list in an Attribute

Set the authorized list of IP's.

getIPAuthorizedList

public java.util.ArrayList getIPAuthorizedList()
Deprecated. no longer used by the server developers using this should maintain the list in an Attribute

Get the authorized list of IP's.

isAutojoin

public boolean isAutojoin()
Returns true if clients are set to join the Room when they connect to the server.

setAutojoin

public void setAutojoin(boolean setter)
Set to true if the clients are set to join the Room when they connect to the server.

setAttribute

public void setAttribute(org.moock.unity.core.Attribute attribute)
Set the attributes for the room.

getAttributes

public java.util.ArrayList getAttributes()
Set the attributes for the room.

setNamespace

public void setNamespace(java.lang.String namespace)
Sets the parent room ID.

getNamespace

public java.lang.String getNamespace()
Gets the namespace this room is associated with.

getRoomType

public java.lang.String getRoomType()
Gets the type of Room as defined in RoomTypes.xml.

setRoomType

public void setRoomType(java.lang.String setter)
Sets the type of Room as defined in RoomTypes.xml.

getRoomID

public java.lang.String getRoomID()
Set the ID of the Room.

setRoomID

public void setRoomID(java.lang.String setter)
Get the ID of the Room.

setAuthentication

public void setAuthentication(int authentication)
Sets the authentication for the room.

getAuthentication

public int getAuthentication()
Get the authentication for the room.

setDieOnEmpty

public void setDieOnEmpty(boolean die)
Set to true if the Room should die when the last Client leaves, false otherwise.

isDieOnEmpty

public boolean isDieOnEmpty()
Returns true if the Room should die when the last Client leaves, false otherwise.