Class User

java.lang.Object

User

public class User
extends java.lang.Object

This is the user class which captures profile information of a single user

Constructor Summary

Constructors

Constructor and Description
User(java.lang.String lastName, java.lang.String firstName, java.lang.String nickname, java.lang.String password, java.util.List<Message> messages, java.util.List<User> friends, java.util.List<BroadcastList> broadcastLists) A constructor to instantiate this class.

Method Summary

Modifier and Type	Method and Description
void	addFriend(java.lang.String nickname) add a friend to this user
java.util.List<BroadcastList>	getBroadcastLists() A getter for the list of broadcast lists owned by this user
java.lang.String	getFirstName() A getter for the first name
java.util.List<User>	getFriends() A getter for the list of friends of this user
java.lang.String	getLastName() a getter to return the last name
java.util.List<Message>	getMessages() A getter for the list of all the user messages both sent and received
java.lang.String	getNickname() A getter for the nickname
java.lang.String	getPassword() A getter for the user password
boolean	isBroadcastList(java.lang.String nickname) this method check whether supplied nickname is a broadcast list of this user object
boolean	isExistingNickname(java.lang.String nickname) checks if the supplied nickname is associated with this user object.
boolean	isFriend(java.lang.String nickname) this method check whether supplied nickname is a friend of this user object
boolean	isMemberOfBroadcastList(java.lang.String nickname, java.lang.String broadcastNickname) checks whether the supplied nickname is part of the broadcastNickname list both associated with this user object
void	removeBroadcastList(java.lang.String broadcastNickname) this method removes a broadcast list from this user object
void	removeFriend(java.lang.String nickname) remove a friend from this user object
void	setBroadcastLists(java.util.List<BroadcastList> broadcastLists) A setter for the list of broadcast lists owned by this user
void	setFirstName(java.lang.String firstName) A setter for the first name
void	setFriends(java.util.List<User> friends) A setter for the list of all friends of this user
void	setLastName(java.lang.String lastName) A setter for the last name
void	setMessages(java.util.List<Message> messages) A setter for the list of all the user messages
void	setNickname(java.lang.String nickname) A setter for the nickname
void	setPassword(java.lang.String password) A setter for the use password

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(java.lang.String lastName,
            java.lang.String firstName,
            java.lang.String nickname,
            java.lang.String password,
            java.util.List<Message> messages,
            java.util.List<User> friends,
            java.util.List<BroadcastList> broadcastLists)
     throws WhatsAppRuntimeException

A constructor to instantiate this class. None of the Strings passed to this can be null or empty. Also any of the lists passed to this constructor cannot be null. You can create empty ArrayLists and pass it here. For any of the above mentioned validation issues, you must throw a WhatsAppRuntimeException with the CANT_BE_EMPTY_OR_NULL message

Parameters:

lastName - last name of the user

firstName - first name of the user

nickname - nickname of the user. This must be unique across all users

password - password of the user

messages - list of messages in the user's message list. This includes both messages sent and received by the user.

friends - list of users who are friends of this user

broadcastLists - list of broadcast lists that this user owns

Throws:

WhatsAppRuntimeException - if any of the strings passed to this constructor are either null or empty or any of the lists passed to this are null (they can be empty) throw an instance of this exception with the message CANT_BE_EMPTY_OR_NULL

Method Detail

getLastName

public java.lang.String getLastName()

a getter to return the last name

Returns:

the last name

setLastName

public void setLastName(java.lang.String lastName)

A setter for the last name

Parameters:

lastName - - the last name of a user

getFirstName

public java.lang.String getFirstName()

A getter for the first name

Returns:

the first name

setFirstName

public void setFirstName(java.lang.String firstName)

A setter for the first name

Parameters:

firstName - the first name of a user

getNickname

public java.lang.String getNickname()

A getter for the nickname

Returns:

the nickname of a user

setNickname

public void setNickname(java.lang.String nickname)

A setter for the nickname

Parameters:

nickname - the nickname of a user

getPassword

public java.lang.String getPassword()

A getter for the user password

Returns:

the user password

setPassword

public void setPassword(java.lang.String password)

A setter for the use password

Parameters:

password - the user password

getMessages

public java.util.List<Message> getMessages()

A getter for the list of all the user messages both sent and received

Returns:

the list containing all the user messages

setMessages

public void setMessages(java.util.List<Message> messages)

A setter for the list of all the user messages

Parameters:

messages - a list of all the user messages

getFriends

public java.util.List<User> getFriends()

A getter for the list of friends of this user

Returns:

a list of all the user's friends

setFriends

public void setFriends(java.util.List<User> friends)

A setter for the list of all friends of this user

Parameters:

friends - a list of all friends this user has

getBroadcastLists

public java.util.List<BroadcastList> getBroadcastLists()

A getter for the list of broadcast lists owned by this user

Returns:

the list of broadcast lists

setBroadcastLists

public void setBroadcastLists(java.util.List<BroadcastList> broadcastLists)

A setter for the list of broadcast lists owned by this user

Parameters:

broadcastLists - the list of broadcast lists

removeBroadcastList

public void removeBroadcastList(java.lang.String broadcastNickname)
                         throws WhatsAppException

this method removes a broadcast list from this user object

Parameters:

broadcastNickname - the nickname of the broadcast list to remove

Throws:

WhatsAppException - throw this with BCAST_LIST_DOES_NOT_EXIST as the message if the broadcast list asked to remove does not exist

isFriend

public boolean isFriend(java.lang.String nickname)

this method check whether supplied nickname is a friend of this user object

Parameters:

nickname - the nickname of the user to be checked whether he is a friend

Returns:

true if nickname is a friend of this user object

isBroadcastList

public boolean isBroadcastList(java.lang.String nickname)

this method check whether supplied nickname is a broadcast list of this user object

Parameters:

nickname - the nickname of the user to be checked whether it is a broadcast list of this user object

Returns:

true if nickname is a broadcast list of this user object

isExistingNickname

public boolean isExistingNickname(java.lang.String nickname)

checks if the supplied nickname is associated with this user object. It can be either a friend or a broadcast list

Parameters:

nickname - the nickname to check against

Returns:

true if the nickname supplied is either a friend or a broadcast list of this user object

isMemberOfBroadcastList

public boolean isMemberOfBroadcastList(java.lang.String nickname,
                                       java.lang.String broadcastNickname)

checks whether the supplied nickname is part of the broadcastNickname list both associated with this user object

Parameters:

nickname - the nickname of the user

broadcastNickname - the nickname of the broadcastList

Returns:

true if nickname is a part of the list represented by broadcastNickname

addFriend

public void addFriend(java.lang.String nickname)
               throws WhatsAppException

add a friend to this user

Parameters:

nickname - the nickname of the user who is to become a friend of this user object

Throws:

WhatsAppException - throw a new instance of this exception with one of the following messages: CANT_BE_OWN_FRIEND (if trying to add the the same user to itself), ALREADY_A_FRIEND (if the nickname is already a friend of this user), CANT_LOCATE (if the supplied nickname is not even an existing global contact)

removeFriend

public void removeFriend(java.lang.String nickname)
                  throws WhatsAppException

remove a friend from this user object

Parameters:

nickname - the nickname of the friend whom to remove as a friend of this user object

Throws:

WhatsAppException - throw a new instance of this exception with NOT_A_FRIEND (if nickname is not a friend of this user)