net.kano.joscar.snaccmd.chat
Class RoomInfoUpdate

java.lang.Object
  extended bySnacCommand
      extended byChatCommand
          extended byRoomInfoUpdate

public class RoomInfoUpdate
extends ChatCommand

A SNAC command containing various information about a chat room.

Source of this SNAC:
AIM server
SNAC command type:
Family 0x0e, command 0x02

Field Summary
 
Fields inherited from class ChatCommand
CMD_RECV_CHAT_MSG, CMD_ROOM_UPDATE, CMD_SEND_CHAT_MSG, CMD_USERS_JOINED, CMD_USERS_LEFT, FAMILY_CHAT, FAMILY_INFO
 
Fields inherited from class SnacCommand
SNACFLAG_DEFAULT
 
Constructor Summary
  RoomInfoUpdate(FullRoomInfo roomInfo)
          Creates a new outgoing room information command with the given room information.
protected RoomInfoUpdate(SnacPacket packet)
          Creates a new room information update command from the given incoming SNAC packet.
 
Method Summary
 FullRoomInfo getRoomInfo()
          Returns the room information contained in this room information update command.
 java.lang.String toString()
           
 void writeData(java.io.OutputStream out)
          Writes this command's SNAC data block to the given stream.
 
Methods inherited from class SnacCommand
getCommand, getFamily, getFlag1, getFlag2
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RoomInfoUpdate

protected RoomInfoUpdate(SnacPacket packet)
Creates a new room information update command from the given incoming SNAC packet.

Parameters:
packet - a room information update packet

RoomInfoUpdate

public RoomInfoUpdate(FullRoomInfo roomInfo)
Creates a new outgoing room information command with the given room information.

Parameters:
roomInfo - the room information being updated
Method Detail

getRoomInfo

public final FullRoomInfo getRoomInfo()
Returns the room information contained in this room information update command.

Returns:
the updated room information

writeData

public void writeData(java.io.OutputStream out)
               throws java.io.IOException
Description copied from class: SnacCommand
Writes this command's SNAC data block to the given stream. The SNAC data block is the data after the first ten bytes of a SNAC packet.

Specified by:
writeData in class SnacCommand
Parameters:
out - the stream to which to write the SNAC data
Throws:
java.io.IOException - if an I/O error occurs

toString

public java.lang.String toString()