Class Message

java.lang.Object

Message

public class Message
extends java.lang.Object

This is the message class which captures information of a message Every logical message will result in at least two Message objects. One always goes to the message list of the sender user. The others, depending on whether the message was sent to a single user or a broadcast, will go to the message lists of the target user(s). For a one to one message (non broadcast messages), fromNickname and toNickname assume appropriate values. broadcastNickname is null for such cases. For broadcast messages, the sender Message object has a null for toNickname. Instead the broadcastNickname is populated. However, on the receivers' (people who belong to the broadcast list), the toNickname is their own nicknames. They have no idea it came through a broadcast. Hence, broadcastNickname is null for the Message objects that go to the receivers' message lists. fromNickname always assumes the sender's nickname. read is true for the sender's Message object. It's always false in the beginning, for the receivers' Message object until they read the message.

Constructor Summary

Constructors

Constructor and Description
Message(java.lang.String fromNickname, java.lang.String toNickname, java.lang.String broadcastNickname, java.util.Date sentTime, java.lang.String message, boolean read) A constructor to instantiate this class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBroadcastNickname() A getter for the broadcastNickname
java.lang.String	getFromNickname() A getter for the fromNickname
java.lang.String	getMessage() A getter for the message string
java.util.Date	getSentTime() A getter for the time at which this message was sent
java.lang.String	getToNickname() A getter for the toNickname
boolean	isRead() A getter for the read flag which indicates whether the message has been read
void	setBroadcastNickname(java.lang.String broadcastNickname) A setter for the broadcastNickname
void	setFromNickname(java.lang.String fromNickname) A setter for the fromNickname
void	setMessage(java.lang.String message) A setter for the message string
void	setRead(boolean read) A setter for the read flag which indicates whether the message has been read
void	setSentTime(java.util.Date sentTime) A setter for the time at which this message was sent
void	setToNickname(java.lang.String toNickname) A setter for the toNickname

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Message

public Message(java.lang.String fromNickname,
               java.lang.String toNickname,
               java.lang.String broadcastNickname,
               java.util.Date sentTime,
               java.lang.String message,
               boolean read)
        throws WhatsAppRuntimeException

A constructor to instantiate this class. fromNickname and message cannot be null or empty. toNickname must be null, if broadcastNockname is provided. Alternatively, broadcastNickname must be null if toNickname is provided. sentTime cannot be null. For any of the above mentioned validation issues, you must throw a WhatsAppRuntimeException with the CANT_BE_EMPTY_OR_NULL message

Parameters:

fromNickname - the nickname of the user sending the message

toNickname - the nickname of the user to whom the message is being sent. This must be null if the message is being broadcast to a broadcast list

broadcastNickname - the nickname of the broadcast list to which this message is being sent. This must be null if the message is being sent to a single user

sentTime - the instant of time at which the message was sent

message - the message string that is being communicated from the sender to the receiver(s)

read - whether the receiver has read this message

Throws:

WhatsAppRuntimeException - read the description of this constructor for the conditions failing which you may throw this exception

Method Detail

getFromNickname

public java.lang.String getFromNickname()

A getter for the fromNickname

Returns:

the fromNickname of this message

setFromNickname

public void setFromNickname(java.lang.String fromNickname)

A setter for the fromNickname

Parameters:

fromNickname - the fromNickname of this message

getToNickname

public java.lang.String getToNickname()

A getter for the toNickname

Returns:

the toNickname of this message

setToNickname

public void setToNickname(java.lang.String toNickname)

A setter for the toNickname

Parameters:

toNickname - the toNickname of this message

getBroadcastNickname

public java.lang.String getBroadcastNickname()

A getter for the broadcastNickname

Returns:

the broadcastNickname of this message

setBroadcastNickname

public void setBroadcastNickname(java.lang.String broadcastNickname)

A setter for the broadcastNickname

Parameters:

broadcastNickname - the broadcastNickname of this message

getSentTime

public java.util.Date getSentTime()

A getter for the time at which this message was sent

Returns:

the Date object which captures the time at which this message was sent

setSentTime

public void setSentTime(java.util.Date sentTime)

A setter for the time at which this message was sent

Parameters:

sentTime - the Date object which captures the time at which this message was sent

getMessage

public java.lang.String getMessage()

A getter for the message string

Returns:

the message string

setMessage

public void setMessage(java.lang.String message)

A setter for the message string

Parameters:

message - the message string

isRead

public boolean isRead()

A getter for the read flag which indicates whether the message has been read

Returns:

the read flag

setRead

public void setRead(boolean read)

A setter for the read flag which indicates whether the message has been read

Parameters:

read - the read flag