net.kano.joscar.snaccmd.conn
Class SnacFamilyListCmd

java.lang.Object
  extended bySnacCommand
      extended byConnCommand
          extended bySnacFamilyListCmd
Direct Known Subclasses:
PauseAck, ServerReadyCmd

public abstract class SnacFamilyListCmd
extends ConnCommand

A base class for the two SNAC commands that contain a list of SNAC families. These commands are PauseAck and ServerReadyCmd.


Field Summary
 
Fields inherited from class ConnCommand
CMD_CLIENT_READY, CMD_CLIENT_VERS, CMD_ENCINFOACK, CMD_EXTRA_ACK, CMD_MIGRATE_PLS, CMD_MY_INFO_REQ, CMD_NOOP, CMD_PAUSE, CMD_PAUSE_ACK, CMD_RATE_ACK, CMD_RATE_CHG, CMD_RATE_INFO, CMD_RATE_REQ, CMD_RESUME, CMD_SERV_VERS, CMD_SERVER_READY, CMD_SERVICE_REDIR, CMD_SERVICE_REQ, CMD_SET_IDLE, CMD_SETENCINFO, CMD_SETEXTRAINFO, CMD_UPDATE, CMD_WARNED, CMD_YOUR_INFO, FAMILY_CONN, FAMILY_INFO
 
Fields inherited from class SnacCommand
SNACFLAG_DEFAULT
 
Constructor Summary
protected SnacFamilyListCmd(int command, int[] snacFamilies)
          Creates a new outgoing SNAC-family-list-based command with the given SNAC command subtype and the given SNAC family list.
protected SnacFamilyListCmd(int command, SnacPacket packet)
          Generates a new snac family list command of the given SNAC command subtype and the given incoming SNAC packet.
 
Method Summary
 int[] getSnacFamilies()
          Returns the SNAC families contained 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

SnacFamilyListCmd

protected SnacFamilyListCmd(int command,
                            SnacPacket packet)
Generates a new snac family list command of the given SNAC command subtype and the given incoming SNAC packet.

Parameters:
command - the SNAC command subtype of this command
packet - the incoming SNAC-family-list-based packet

SnacFamilyListCmd

protected SnacFamilyListCmd(int command,
                            int[] snacFamilies)
Creates a new outgoing SNAC-family-list-based command with the given SNAC command subtype and the given SNAC family list.

Parameters:
command - the SNAC command subtype of this command
snacFamilies - the SNAC families contained in this command
Method Detail

getSnacFamilies

public final int[] getSnacFamilies()
Returns the SNAC families contained in this command.

Returns:
this command's associated SNAC families

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