UserJavadoc

code format="java" package facePlace; /
 * Represents a user that contains the name, username, email, password, gender, notifications, relationship, bio, privacy,a wall, events, groups, blocked users, pictures, friends, and messages.**
 * author Amanda**


 * public class User{**
 * private String name;**
 * private String username;**
 * private String email;**
 * private String password;**
 * private boolean gender;**
 * private boolean relationship;**
 * private String bio;**
 * private boolean privacy;**
 * private ArrayList notifications;**
 * private ArrayList wall;**
 * private String profilePic;**
 * private Hashtable friendsList;**
 * private ArrayList inbox;**
 * private ArrayList events;**
 * private Arraylist groups;**
 * private Hashtable blockedPeople;**
 * private ArrayList album;**


 * User(String name, String username, String email, String password){**


 * }**

public String getName{ return name; }
 * Returns the String value of the name associated with the User.
 * @return the name of the User.
 * @return the name of the User.

/
 * Returns the String value of the username associated with the User.**
 * @return the username of the User.**
 * public String getUsername{**
 * return username;**
 * }**
 * }**

public String getEmail{ return email; }
 * Returns the String value of the email associated with the User.
 * @return the email of the User.
 * @return the email of the User.

/
 * Returns the String value of the password associates with the User.**
 * @return the password of the User.**
 * public String getPassword{**
 * returns password;**
 * }**
 * }**

public String getBio{ return bio; }
 * Returns the String value of the bio associated with the String.
 * @return the bio of the User.
 * @return the bio of the User.

/
 * Returns the String value of the profile picture associated with the String.**
 * @return the string of the picture of the User.**
 * public String getProfilePic{**
 * return profilePic;**
 * }**
 * }**

public ArrayList getNotifications{
 * Returns the ArrayList notifications associated with the User.
 * @return the notifications of the user.
 * @return the notifications of the user.

}

/
 * Returns the boolean value associated with the gender of the user.**
 * @return true if the gender is female or false if the gender is male.**
 * public boolean getGender{**
 * public boolean getGender{**


 * }**

public boolean getRelation{
 * Returns the boolean value associated with the gender of the user.
 * @return true if the user is in a relationship or false if not.
 * @return true if the user is in a relationship or false if not.

}

/
 * Returns the boolean value associated with the privacy setting of the user.**
 * @return true if the user has their privacy setting on or false if not.**
 * public boolean getPrivacy{**
 * public boolean getPrivacy{**


 * }**

public ArrayList getEvents{
 * Returns the ArrayList events being attended by the associated user.
 * @return the events of the user.
 * @return the events of the user.

}

/
 * Returns the ArrayList groups the associated user is a member of.**
 * @return the groups of the user**
 * public ArrayList getGroups{**
 * public ArrayList getGroups{**


 * }**

public ArrayList getInbox{
 * Returns the ArrayList<Message messages that have been sent to the the associated user, whether read or unread.
 * @return the messages sent to the user.
 * @return the messages sent to the user.

}

/
 * Returns a Hashtable<User> list of the names(of other users)that the user has blocked.**
 * @return the name of the users that the associated user has blocked.**
 * public Hashtable<User> getBlockedPeople{**
 * public Hashtable<User> getBlockedPeople{**


 * }**

public Hashtable<User> getFriends{
 * Returns a Hashtable<User> list of the names (of the users) that are friends with the associated user.
 * @return the name of the users that are friends of the user
 * @return the name of the users that are friends of the user

}

/
 * Returns a ArrayList<String> of the pictures associated with the user.**
 * @return the user's pictures**
 * public ArrayList<String> getAlbum{**
 * public ArrayList<String> getAlbum{**


 * }**

public void setprofilePic(String pic){ this.profilePic=pic; }
 * Sets the String value of the profile pic as the new profile pic for the associated user.
 * @param pic the String for the picture to be set as the new profile pic
 * @param pic the String for the picture to be set as the new profile pic

/
 * Sets the input string to the name variable of the associated user.**
 * @param name a string containing the name that is to be set as the new name of the user**
 * public void setName(String name){**
 * this.name=name;**
 * }**
 * }**

public void setUsername(String username){ this.username=username; }
 * Sets the input string to the username variable of the associated user.
 * @param username a string containing the username that is to be set as the new username of the user
 * @param username a string containing the username that is to be set as the new username of the user

/
 * Sets the input string to the email variable of the associated user.**
 * @param email a string containing the email that is to be set as the new email of the user.**
 * public void setEmail(String email){**
 * this.email=email;**
 * }**
 * }**

public void setPassword(String password){ this.password=password; }
 * Sets the input string to the password of the associated user.
 * @param password a string containing the password that is to be set as the new password of the user.
 * @param password a string containing the password that is to be set as the new password of the user.

/ public void setGender{ if (gender=false){ gender=true; } else{ gender=false; } }
 * Sets the input string to the bio of the associated user.**
 * @param bio a string containing the bio that is to be set as the new bio of the user.**
 * public void setBio(String bio){**
 * this.bio=bio;**
 * }**
 * Sets the gender variable to the opposite of what it currently is set. If the gender is set to female(true) then the gender is set to male(false) and visaversa.
 * Sets the gender variable to the opposite of what it currently is set. If the gender is set to female(true) then the gender is set to male(false) and visaversa.
 * Sets the gender variable to the opposite of what it currently is set. If the gender is set to female(true) then the gender is set to male(false) and visaversa.

/
 * Sets the relation variable to the opposite of what it is currently set. If the relation is set to in a relationship(true) then the relation is set to single (false) and visaversa.**
 * public void setRelation{**
 * if(relation=false){**
 * relation=true;**
 * }**
 * else{**
 * relation=false;**
 * }**
 * }**
 * }**

public void setPrivacy{ if(privacy=false){ privacy=true; } else{ privacy=false; } }
 * Sets the privacy variable to the opposite of what it is currently set. If the privacy is off(false) then the privacy is set to on(true) and visaversa.
 * Sets the privacy variable to the opposite of what it is currently set. If the privacy is off(false) then the privacy is set to on(true) and visaversa.

/
 * Adds a friend to the ArrayList of friends of the associated user.**
 * @param friend a user that is to be added to the ArrayList.**
 * public void addFriend(User friend){**
 * public void addFriend(User friend){**


 * }**

public void addGroup(Group group){
 * Adds a group to the ArrayList of groups of the associated user.
 * @param group a user that is to be added to the ArrayList.
 * @param group a user that is to be added to the ArrayList.

}

/
 * Adds a event to the ArrayList of events of the associated user.**
 * @param event a user that is to be added to the ArrayList.**
 * public void addEvent(Event event){**
 * public void addEvent(Event event){**

public void addPicture(String picture){
 * }**
 * Adds a picture to the ArrayList of pictures of the associated user.
 * @param picture a user that is to be added to the ArrayList.
 * @param picture a user that is to be added to the ArrayList.

}

/
 * Adds a user to the ArrayList of blocked users of the associated user.**
 * @param a user that is to be added to the ArrayList of blocked users.**
 * public void addABlockedUser(User user){**
 * public void addABlockedUser(User user){**


 * }**

public void addRequestNotification(User sender){
 * Adds a friend request notification to the ArrayList of notifications of the associated user.
 * @param a notification that is to be added to the ArrayList of notifications.
 * @param a notification that is to be added to the ArrayList of notifications.

}

/
 * Adds a wall post request notification to the ArrayList of notifications of the associated user when the privacy setting is on.**
 * @param a notification that is to be added to the ArrayList of notifications.**
 * public void addWallPostRequestNotification(User sender){**
 * public void addWallPostRequestNotification(User sender){**


 * }**

public void addWallPostNotification(User sender){
 * Adds a wall post notification to the ArrayList of notifications of the associated user when the privacy setting is off..
 * @param a notification that is to be added to the ArrayList of notifications.
 * @param a notification that is to be added to the ArrayList of notifications.

}

/
 * Adds a event notification to the ArrayList of notifications of the associated user.**
 * @param a notification that is to be added to the ArrayList of notifications.**
 * public void addEventNotification(User sender){**
 * public void addEventNotification(User sender){**

public void removeFriend(User friend){
 * }**
 * Removes a friend from the ArrayList of friends of the associated user.
 * @param friend a user that is to be removed from the ArrayList.
 * @param friend a user that is to be removed from the ArrayList.

}

/
 * Removes a group from the ArrayList of groups of the associated user.**
 * @param group a group that is to be removed from the ArrayList.**
 * public void removeGroup(Group group){**
 * public void removeGroup(Group group){**


 * }**

public void removeEvent(Event event){
 * Removes a event from the ArrayList of events of the associated user.
 * @param event a event that is to be removed from the ArrayList.
 * @param event a event that is to be removed from the ArrayList.

}

//+blockAUser(user:User):void

/
 * Unblock a user from the ArrayList of blocked users of the associated user.**
 * @param user a user that is to be removed from the ArrayList.**
 * public void unblockAUser(user:User){**
 * public void unblockAUser(user:User){**


 * }**

public void save{
 * Saves the user, the groups, events, friends,and blocked users to a file associated with the username.
 * Saves the user, the groups, events, friends,and blocked users to a file associated with the username.

}

/** public void load{
 * Loads the user, the groups, events, friends, and blocked users of the associated user from file.

}

}

code