net.user1.union.core.context
Interface ModuleContext

public interface ModuleContext

ModuleContext contains contextual information about the environment in which a module is running. Modules use this to obtain references to the server and room modules use this context to get a reference to the room with which they are associated.

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns a name-value map of the attributes that have been set for this module.
Room	getRoom() If this is a room module it returns the room associated with the module.
Server	getServer() Gets a reference to the server.

Method Detail

getServer

Server getServer()

Gets a reference to the server.

Returns:

a reference to the server

getRoom

Room getRoom()

If this is a room module it returns the room associated with the module. Otherwise it returns null.

Returns:

the room associated with the module

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns a name-value map of the attributes that have been set for this module.

Returns:

the Attributes that have been set for this module