net.user1.union.core.def
Class RoomDef

java.lang.Object
  net.user1.union.core.def.RoomDef

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class RoomDef
extends java.lang.Object
implements java.io.Externalizable

A RoomDef defines how a room should be constructed.

See Also:

Serialized Form

Constructor Summary

RoomDef()
Constructor.

RoomDef(java.lang.String roomID)
Constructor.

Method Summary

void	addAttribute(AttributeDef attr) Add an attribute to the room.
void	addModule(ModuleDef mod) Add a room module to be deployed with the room.
java.util.Set<AttributeDef>	getAttributes() Get the attributes set for this room.
java.lang.String	getOwnerID() Get the clientID of the owner of the room.
java.lang.String	getRoomID() Get the ID of the room.
java.util.List<ModuleDef>	getRoomModules() Returns a list of the modules to be deployed with the room.
void	readExternal(java.io.ObjectInput in)
void	setModules(java.util.List<ModuleDef> mods) Set a list of modules to be deployed with the room.
void	setOwnerID(java.lang.String ownerID) Set the clientID of the owner of the room.
void	setRoomID(java.lang.String roomID) Set the ID of the room.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoomDef

public RoomDef()

Constructor.

RoomDef

public RoomDef(java.lang.String roomID)

Constructor.

Method Detail

addModule

public void addModule(ModuleDef mod)

Add a room module to be deployed with the room.

Parameters:

mod - - the module definition to add

setModules

public void setModules(java.util.List<ModuleDef> mods)

Set a list of modules to be deployed with the room.

Parameters:

mods - - the module definitions to set

getRoomModules

public java.util.List<ModuleDef> getRoomModules()

Returns a list of the modules to be deployed with the room.

Returns:

a list of the modules to be deployed with the room

addAttribute

public void addAttribute(AttributeDef attr)

Add an attribute to the room.

Parameters:

attr - - an attribute

getAttributes

public java.util.Set<AttributeDef> getAttributes()

Get the attributes set for this room.

Returns:

the attributes set for this room

getRoomID

public java.lang.String getRoomID()

Get the ID of the room.

Returns:

the ID of the room

setRoomID

public void setRoomID(java.lang.String roomID)

Set the ID of the room. If set to null or an empty String then an ID will be automatically generated. If a room with the roomID already exists on the server then the creation of the room with the RoomDef will throw a RoomAlreadyExistsException.

Parameters:

roomID - - the ID of the room

getOwnerID

public java.lang.String getOwnerID()

Get the clientID of the owner of the room.

Returns:

the clientID of the owner of the room

setOwnerID

public void setOwnerID(java.lang.String ownerID)

Set the clientID of the owner of the room.

Parameters:

ownerID - - the clientID of the owner of the room

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException