net.kano.joscar.snaccmd.loc
Class SetDirInfoCmd

java.lang.Object
  extended bySnacCommand
      extended byLocCommand
          extended bySetDirInfoCmd

public class SetDirInfoCmd
extends LocCommand

A SNAC command used to set one's directory information. Normally responded-to with a SetDirAck.

See Also:
SetDirAck
Source of this SNAC:
AIM client
SNAC command type:
Family 0x02, command 0x09

Field Summary
 
Fields inherited from class LocCommand
CMD_DIR_INFO, CMD_GET_DIR, CMD_INTEREST_ACK, CMD_NEW_GET_INFO, CMD_OLD_GET_INFO, CMD_RIGHTS_REQ, CMD_RIGHTS_RESP, CMD_SET_DIR, CMD_SET_DIR_ACK, CMD_SET_INFO, CMD_SET_INTERESTS, CMD_USER_INFO, FAMILY_INFO, FAMILY_LOC
 
Fields inherited from class SnacCommand
SNACFLAG_DEFAULT
 
Constructor Summary
  SetDirInfoCmd(DirInfo dirInfo)
          Creates a new outgoing set-directory-information command with the given directory information, or null to clear directory info.
protected SetDirInfoCmd(SnacPacket packet)
          Generates a set-directory-info command from the given incoming SNAC packet.
 
Method Summary
 DirInfo getDirInfo()
          Returns the directory information to be set, or null to clear the currently set directory information.
 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

SetDirInfoCmd

protected SetDirInfoCmd(SnacPacket packet)
Generates a set-directory-info command from the given incoming SNAC packet.

Parameters:
packet - an incoming set-directory-information packet

SetDirInfoCmd

public SetDirInfoCmd(DirInfo dirInfo)
Creates a new outgoing set-directory-information command with the given directory information, or null to clear directory info.

Parameters:
dirInfo - the directory information to set, or null to clear the directory information currently set
Method Detail

getDirInfo

public final DirInfo getDirInfo()
Returns the directory information to be set, or null to clear the currently set directory information.

Returns:
the directory 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()