es.uvigo.esei.dgss.teamc.microstories.entities

Class User

java.lang.Object

es.uvigo.esei.dgss.teamc.microstories.entities.User

All Implemented Interfaces:

Serializable

@Entity(name="User")
public class User
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	login
protected String	password

Constructor Summary

Constructors

Constructor and Description
User()
User(String login, String password, String role) Creates a new instance of User
User(String login, String password, String role, List<Story> stories) Creates a new instance of User

Method Summary

Modifier and Type	Method and Description
void	addStory(Story story) Adds a story directly to the stories collection of this user if the story does not already belongs to this user.
void	changePassword(String password) Changes the password of the user.
List<Story>	getCreatedStories() Returns the list of stories that user creates
String	getLogin() Returns the login of the user
String	getPassword() Returns the password of the user
String	getRole() Returns the role of the user
boolean	isAuthorofStory(Story story) Checks if a story belongs to this user.
void	removeStory(Story story) Removes a story directly from the stories collection of this user.
void	setCreatedStories(List<Story> createdStories) Sets the list of stories that user creates.
void	setLogin(String login) Sets the login of the user.
void	setPassword(String password) Sets the password of the user.
void	setRole(String role) Sets the role of the user.

Methods inherited from class java.lang.Object

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

Field Detail

login

protected String login

password

protected String password

Constructor Detail

User

public User()

User

public User(String login,
            String password,
            String role)

Creates a new instance of User

Parameters:

login - the login of the user. This parameter must be a non empty and non null string with a maximun length of 100 chars

password - the password of the user. This parameter must be a non empty and non null string with a maximum length of 32 chars

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

User

public User(String login,
            String password,
            String role,
            List<Story> stories)

Creates a new instance of User

Parameters:

login - the login of the user. This parameter must be a non empty and non null string with a maximun length of 100 chars

password - the password of the user. This parameter must be a non empty and non null string with a maximum length of 32 chars

stories - the stories that belong to this user. The list of stories can be empty. null values are not supported.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

Method Detail

getLogin

public String getLogin()

Returns the login of the user

Returns:

the login of the user

setLogin

public void setLogin(String login)

Sets the login of the user.

Parameters:

login - the login of the user. This parameter must be a non empty and non null string with a maximun length of 100 chars

Throws:

NullPointerException - if a null value is passed

IllegalArgumentException - if the length of the passed string is not valid

getPassword

public String getPassword()

Returns the password of the user

Returns:

the password of the user

setPassword

public void setPassword(String password)

Sets the password of the user.

Parameters:

password - the password of the user. This parameter must be a non empty and non null string with a maximun length of 32 chars

Throws:

NullPointerException - if a null value is passed

IllegalArgumentException - if the length of the passed string is not valid

getRole

public String getRole()

Returns the role of the user

Returns:

the role of the user

setRole

public void setRole(String role)

Sets the role of the user.

Parameters:

role - the role of the user. This parameter must be a non empty and non null string with a maximun length of 10 chars

Throws:

NullPointerException - if a null value is passed

IllegalArgumentException - if the length of the passed string is not valid

getCreatedStories

public List<Story> getCreatedStories()

Returns the list of stories that user creates

Returns:

list of stories that user creates

setCreatedStories

public void setCreatedStories(List<Story> createdStories)

Sets the list of stories that user creates.

Parameters:

createdStories - the of stories that user creates.The list of stories can be empty. null values are not supported.

Throws:

NullPointerException - if a null value is passed

addStory

public void addStory(Story story)

Adds a story directly to the stories collection of this user if the story does not already belongs to this user. The story's author will not be updated. If the story already belongs to this user, no action will be done.

Parameters:

story - the story to add to this user. null values not supported.

Throws:

NullPointerException - if the story is null.

removeStory

public void removeStory(Story story)

Removes a story directly from the stories collection of this user. The story's author will not be updated.

Parameters:

story - the story to remove from this user. null values not supported.

Throws:

NullPointerException - if the story is null.

isAuthorofStory

public boolean isAuthorofStory(Story story)

Checks if a story belongs to this user.

Parameters:

story - the story whose property will be checked.

Returns:

true if the story belongs to this user. false otherwise.

changePassword

public void changePassword(String password)

Changes the password of the user. This method receives the rawvalue of the password and stores it in MD5 format.

Parameters:

password - the raw password of the user. This parameter must be a non null string with a minimum length of 6 chars.

Throws:

NullPointerException - if the password is null.

IllegalArgumentException - if the length of the string passed is not valid.