com.web_visage.ichat.messages
Class IChatStatusMessage

java.lang.Object
  com.web_visage.ichat.IChatMessage
      com.web_visage.ichat.messages.IChatStatusMessage

All Implemented Interfaces:

IChatMessageConstants

public class IChatStatusMessage
extends IChatMessage

iChat status message.

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

IChatStatusMessage(int aMsgNumber, IChatSender aSender, EnumStatus aStatus, java.lang.String aGreetingMessage)
Constructor.

Method Summary

void	acceptVisitor(IChatMessageVisitor aVisitor) Accepts the IChatMessageVisitorimplementations.
java.lang.String	getGreetingMessage() Returns the greeting message.
EnumStatus	getStatus() Returns the status.
static IChatStatusMessage	newInstance(int aMsgNumber, IChatSender aSender, IChatParameterAccessor aParameters) Creates a message by the given raw parameters array.
IChatStatusMessage	updateGreetingsMessage(java.lang.String message) Returns new instance of the message with an updated greeting message field.

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

IChatStatusMessage

public IChatStatusMessage(int aMsgNumber,
                          IChatSender aSender,
                          EnumStatus aStatus,
                          java.lang.String aGreetingMessage)

Constructor.

Parameters:

aMsgNumber -

aCommand -

aSender -

aParameters -

Method Detail

getStatus

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

Returns the status.

Returns:

Throws:

java.lang.NumberFormatException

EnumerationValueNotFoundException

getGreetingMessage

public final java.lang.String getGreetingMessage()

Returns the greeting message.

Returns:

updateGreetingsMessage

public IChatStatusMessage updateGreetingsMessage(java.lang.String message)
                                          throws java.lang.NumberFormatException,
                                                 EnumerationValueNotFoundException

Returns new instance of the message with an updated greeting message field.

Parameters:

message -

Returns:

Throws:

java.lang.NumberFormatException

EnumerationValueNotFoundException

newInstance

public static IChatStatusMessage newInstance(int aMsgNumber,
                                             IChatSender aSender,
                                             IChatParameterAccessor aParameters)
                                      throws EnumerationValueNotFoundException

Creates a message by the given raw parameters array.

Parameters:

aMsgNumber -

aSender -

aParameters -

Returns:

Throws:

EnumerationValueNotFoundException

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)