com.web_visage.ichat.messages
Class IChatConnectMessage

java.lang.Object
  extended by com.web_visage.ichat.IChatMessage
      extended by com.web_visage.ichat.messages.IChatConnectMessage
All Implemented Interfaces:
IChatMessageConstants

public class IChatConnectMessage
extends IChatMessage

IChat connect message.

Holds information about user being connected to the specific line or common chat.

Author:
K.Baturytski

Field Summary
 
Fields inherited from interface com.web_visage.ichat.IChatMessageConstants
BEGIN_END_MARKER, COMMON_LINE, ICHAT_TAG, PRIVATE_TAG, SEPARATOR, WILDCARD
 
Constructor Summary
IChatConnectMessage(int aMessageId, IChatSender aSender, java.lang.String aLogin, java.lang.String aNickName, java.lang.String aLine, java.lang.String aGreetingMessage, EnumStatus aStatus, java.lang.String aReceiver, java.lang.String aVersion)
          Constructor.
 
Method Summary
 void acceptVisitor(IChatMessageVisitor aVisitor)
          Accepts the IChatMessageVisitorimplementations.
 java.lang.String getGreetingMessage()
          Returns the greeting message.
 java.lang.String getLine()
          Returns the line name.
 java.lang.String getLogin()
          Returns the login.
 java.lang.String getNickName()
          Returns the nickname.
 java.lang.String getReceiver()
          Returns the receiver's string representation.
 EnumStatus getStatus()
          Returns the status.
 java.lang.String getVersion()
          Returns the version.
static IChatConnectMessage newInstance(int aMessageId, IChatSender aSender, IChatParameterAccessor aParameters)
          Creates message by raw parameters array.
 IChatConnectMessage updateGreetingMessage(java.lang.String message)
           
 IChatConnectMessage updateNickname(java.lang.String nickname)
           
 
Methods inherited from class com.web_visage.ichat.IChatMessage
equals, getCmd, getMsgNumber, getParameter, getParameters, getSender, hashCode, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IChatConnectMessage

public IChatConnectMessage(int aMessageId,
                           IChatSender aSender,
                           java.lang.String aLogin,
                           java.lang.String aNickName,
                           java.lang.String aLine,
                           java.lang.String aGreetingMessage,
                           EnumStatus aStatus,
                           java.lang.String aReceiver,
                           java.lang.String aVersion)
Constructor.

Parameters:
aMessageId -
aSender -
aLogin -
aNickName -
aLine -
aGreetingMessage -
aStatus -
aReceiver -
aVersion -
Method Detail

getLine

public final java.lang.String getLine()
Returns the line name.

Returns:

getLogin

public final java.lang.String getLogin()
Returns the login.

Returns:

getNickName

public final java.lang.String getNickName()
Returns the nickname.

Returns:

getGreetingMessage

public final java.lang.String getGreetingMessage()
Returns the greeting message.

Returns:

getReceiver

public final java.lang.String getReceiver()
Returns the receiver's string representation.

Returns:

getVersion

public final java.lang.String getVersion()
Returns the version.

Returns:

getStatus

public final EnumStatus getStatus()
                           throws java.lang.NumberFormatException,
                                  EnumerationValueNotFoundException
Returns the status.

Returns:
Throws:
java.lang.NumberFormatException
EnumerationValueNotFoundException

updateGreetingMessage

public IChatConnectMessage updateGreetingMessage(java.lang.String message)
                                          throws java.lang.NumberFormatException,
                                                 EnumerationValueNotFoundException
Throws:
java.lang.NumberFormatException
EnumerationValueNotFoundException

updateNickname

public IChatConnectMessage updateNickname(java.lang.String nickname)
                                   throws java.lang.NumberFormatException,
                                          EnumerationValueNotFoundException
Throws:
java.lang.NumberFormatException
EnumerationValueNotFoundException

newInstance

public static IChatConnectMessage newInstance(int aMessageId,
                                              IChatSender aSender,
                                              IChatParameterAccessor aParameters)
                                       throws java.lang.NumberFormatException,
                                              EnumerationValueNotFoundException
Creates message by raw parameters array.

Parameters:
aMessageId -
aSender -
aParameters -
Returns:
Throws:
EnumerationValueNotFoundException
java.lang.NumberFormatException

acceptVisitor

public void acceptVisitor(IChatMessageVisitor aVisitor)
Description copied from class: IChatMessage
Accepts the IChatMessageVisitorimplementations.

Specified by:
acceptVisitor in class IChatMessage
See Also:
IChatMessage.acceptVisitor(com.web_visage.ichat.IChatMessageVisitor)