net.kano.joscar.snaccmd.conn
Class WarningNotification

java.lang.Object
  extended bySnacCommand
      extended byConnCommand
          extended byWarningNotification

public class WarningNotification
extends ConnCommand

A SNAC command indicating that the client has been "warned" by another user.

Source of this SNAC:
AIM server
SNAC command type:
Family 0x01, command 0x10

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
  WarningNotification(int level)
          Creates a new outgoing anonymous warning notification command with the given new client warning level.
  WarningNotification(int level, MiniUserInfo by)
          Creates a new outgoing warning notification command with the given properties.
protected WarningNotification(SnacPacket packet)
          Creates a new warning notification command from the given incoming SNAC packet.
 
Method Summary
 int getNewLevel()
          The client's new warning level.
 MiniUserInfo getWarner()
          A miniature user information block for the user who warned the client, or null if the client was warned anonymously.
 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

WarningNotification

protected WarningNotification(SnacPacket packet)
Creates a new warning notification command from the given incoming SNAC packet.

Parameters:
packet - the incoming warning notification packet

WarningNotification

public WarningNotification(int level)
Creates a new outgoing anonymous warning notification command with the given new client warning level. Using this constructor is equvalent to using new WarningNotification(level, null).

Parameters:
level - the client's new warning level

WarningNotification

public WarningNotification(int level,
                           MiniUserInfo by)
Creates a new outgoing warning notification command with the given properties.

Parameters:
level - the client's new warning level
by - the user who warned the client, or null if the user was warned "anonymously"
Method Detail

getNewLevel

public final int getNewLevel()
The client's new warning level.

Returns:
the new warning level

getWarner

public final MiniUserInfo getWarner()
A miniature user information block for the user who warned the client, or null if the client was warned anonymously.

Returns:
an object representing the user who warned the client

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