es.uvigo.esei.dgss.teama.letta.entities

Class Friendship

java.lang.Object

es.uvigo.esei.dgss.teama.letta.entities.Friendship

@Entity
public class Friendship
extends Object

Class that contains everything related to an user.

Author:

Pablo Alonso Barreira

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Friendship.FriendshipKey

Constructor Summary

Constructors

Constructor and Description
Friendship()
Friendship(User user_from, User user_to, FriendshipState state) Creates a new instance of Friendship

Method Summary

Modifier and Type	Method and Description
FriendshipState	getState() Returns the state of the friendship.
User	getUser_from() Returns the user requesting the friendship of the event.
User	getUser_to() Returns the user receiving the friend request.
void	setState(FriendshipState state) Sets the state of this friendship.
void	setUser_from(User user_from) Sets the user_from of this friendship.
void	setUser_to(User user_to) Sets the user_to of this friendship.

Methods inherited from class java.lang.Object

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

Constructor Detail

Friendship

public Friendship()

Friendship

public Friendship(User user_from,
                  User user_to,
                  FriendshipState state)

Creates a new instance of Friendship

Parameters:

user_from - the user requesting the friendship. This parameter must be a non null user.

user_to - the user receiving the friend request. This parameter must be a non null user.

state - the state of the friendship. This parameter is an enumerated of type FriendshipState that must be a non null.

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

getUser_from

public User getUser_from()

Returns the user requesting the friendship of the event.

Returns:

the user requesting the friendship of the event.

setUser_from

public void setUser_from(User user_from)

Sets the user_from of this friendship.

Parameters:

user_from - the user requesting the friendship. This parameter must be a non null user.

Throws:

NullPointerException - if a null value is passed.

getUser_to

public User getUser_to()

Returns the user receiving the friend request.

Returns:

the user receiving the friend request.

setUser_to

public void setUser_to(User user_to)

Sets the user_to of this friendship.

Parameters:

user_to - receiving the friend request. This parameter must be a non null user.

Throws:

NullPointerException - if a null value is passed.

getState

public FriendshipState getState()

Returns the state of the friendship.

Returns:

the state of the friendship.

setState

public void setState(FriendshipState state)

Sets the state of this friendship.

Parameters:

state - the new state of the friendship. This parameter is an enumerated of type FriendshipState that must be a non null.

Throws:

NullPointerException - if a null value is passed.