net.kano.joscar.snaccmd.icbm
Class SetParamInfoCmd

java.lang.Object
  extended bySnacCommand
      extended byIcbmCommand
          extended bySetParamInfoCmd

public class SetParamInfoCmd
extends IcbmCommand

A SNAC command sent to indicate to the server a set of ICBM parameter settings. Normally sent in response to a ParamInfoCmd to modify the (rather conservative) defaults normally imposed by the server.

See Also:
ParamInfoCmd
Source of this SNAC:
AIM client
SNAC command type:
Family 0x01, command 0x02

Field Summary
 
Fields inherited from class IcbmCommand
CMD_ICBM, CMD_MISSED, CMD_MSG_ACK, CMD_PARAM_INFO, CMD_PARAM_INFO_REQ, CMD_RECV_TYPING, CMD_RV_RESPONSE, CMD_SEND_ICBM, CMD_SEND_TYPING, CMD_SET_PARAM_INFO, CMD_WARN, FAMILY_ICBM, FAMILY_INFO
 
Fields inherited from class SnacCommand
SNACFLAG_DEFAULT
 
Constructor Summary
  SetParamInfoCmd(ParamInfo paramInfo)
          Creates a new outgoing set-parameter-information command.
protected SetParamInfoCmd(SnacPacket packet)
          Generates a new set-ICBM-parameter-information command from the given incoming SNAC packet.
 
Method Summary
 ParamInfo getParamInfo()
          Returns the ICBM parameter information block in this 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

SetParamInfoCmd

protected SetParamInfoCmd(SnacPacket packet)
Generates a new set-ICBM-parameter-information command from the given incoming SNAC packet.

Parameters:
packet - an incoming set-ICBM-parameters packet

SetParamInfoCmd

public SetParamInfoCmd(ParamInfo paramInfo)
Creates a new outgoing set-parameter-information command. Note that the maxChannel field of the given ParamInfo should be 0.

Parameters:
paramInfo - the parameter information block to set
Method Detail

getParamInfo

public final ParamInfo getParamInfo()
Returns the ICBM parameter information block in this command.

Returns:
the parameter information being set

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()