com.wilko.jaim
Class IMTocResponse

java.lang.Object
  |
  +--com.wilko.jaim.TocResponse
        |
        +--com.wilko.jaim.IMTocResponse
All Implemented Interfaces:
TocResponseHandler

public class IMTocResponse
extends TocResponse
implements TocResponseHandler

This response is delivered to a JaimEventListener when an instant message is received


Field Summary
static java.lang.String RESPONSE_TYPE
           
 
Fields inherited from class com.wilko.jaim.TocResponse
cmd
 
Constructor Summary
IMTocResponse()
          Creates new TocIMResponse
 
Method Summary
 boolean canHandle(java.lang.String Response)
          Returns true if this response handler can handle the specified response.
 boolean getAutoResponse()
          Is this response an automatically generated response?
 java.lang.String getFrom()
          Obtain the name of the buddy who sent this instant message
 java.lang.String getMsg()
          Obtain the message
 java.lang.String getResponseType()
          Obtain the response type for response dispatching purposes
 com.wilko.jaim.TocResponse parseString(java.lang.String str)
          Parse an incoming IM response string
 
Methods inherited from class com.wilko.jaim.TocResponse
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESPONSE_TYPE

public static final java.lang.String RESPONSE_TYPE
See Also:
Constant Field Values
Constructor Detail

IMTocResponse

public IMTocResponse()
Creates new TocIMResponse

Method Detail

getFrom

public java.lang.String getFrom()
Obtain the name of the buddy who sent this instant message

Returns:
The senders name

getMsg

public java.lang.String getMsg()
Obtain the message

Returns:
The message
See Also:
Utils.stripHTML(java.lang.String)

getAutoResponse

public boolean getAutoResponse()
Is this response an automatically generated response?

Returns:
true if this is an automatically generated response

parseString

public com.wilko.jaim.TocResponse parseString(java.lang.String str)
Parse an incoming IM response string

Specified by:
parseString in interface TocResponseHandler
Parameters:
str - The string to be parsed
Returns:
- A TocResponse object that represents this response

getResponseType

public java.lang.String getResponseType()
Obtain the response type for response dispatching purposes

Specified by:
getResponseType in class TocResponse
Returns:
The response type

canHandle

public boolean canHandle(java.lang.String Response)
Returns true if this response handler can handle the specified response.

Specified by:
canHandle in interface TocResponseHandler
Parameters:
Response - - the response string from TOC. This is the part of the response before the first ':'
Returns:
true if the response can be handled