Added javadocs to User

Signed-off-by: Marcin Woźniak <y0rune@aol.com>

buisnesslogic/src/main/java/com/plannaplan/entities/User.java

@@ -31,6 +31,14 @@ public class User {
     public User() {
     }
 
+    /*
+     * User
+     *
+     * @param name name given to the user
+     * @param surname surname given to the user
+     * @param email mail given to the user
+     * @param role role given to the user
+     */
     public User(String name, String surname, String mail, UserRoles role) {
         this.name = name;
         this.surname = surname;
@@ -38,56 +46,113 @@ public class User {
         this.role = role;
     }
 
+    /*
+     * getEmail
+     *
+     * @return email
+     */
     public String getEmail() {
         return email;
     }
 
+    /*
+     * setEmail
+     *
+     * @param email set email to the user
+     */
     public void setEmail(String email) {
         this.email = email;
     }
 
+    /*
+     * getTokenUsageDate
+     *
+     * @return tokenUsageDate
+     */
     public Timestamp getTokenUsageDate() {
         return tokenUsageDate;
     }
 
+    /*
+     * getToken
+     *
+     * @return token
+     */
     public String getToken() {
         return token;
     }
 
+    /*
+     * setToken
+     *
+     * @param token set token to the entity
+     */
     public void setToken(String token) {
         this.tokenUsageDate = new Timestamp(System.currentTimeMillis());
         this.token = token;
     }
 
+    /* getName
+     *
+     * @return name
+     */
     public String getName() {
         return name;
     }
 
+    /* getRole
+     *
+     * @return role
+     */
     public UserRoles getRole() {
         return role;
     }
 
+    /* setRole
+     *
+     * @param role set role to the entity
+     */
     public void setRole(UserRoles role) {
         this.role = role;
     }
 
+    /*
+     * getSurname
+     * @return surname
+     */
     public String getSurname() {
         return surname;
     }
 
+    /*
+     * setSurname
+     * @param surname set surname into entity user
+     */
     public void setSurname(String surname) {
         this.surname = surname;
     }
 
+    /*
+     * setName
+     * @param name set name into entity user
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /*
+     * getId
+     * @return id
+     */
     public Long getId() {
         return this.id;
     }
 
-    public boolean isCredentialsNonExpired() {
+    /*
+     * isCredentialsNonExpired
+     * Returns TRUE if is Credentials Non Expired in the otherwise it returns false
+     */
+     public boolean isCredentialsNonExpired() {
         final long diffInMilliseconds = Math
                 .abs(this.tokenUsageDate.getTime() - new Timestamp(System.currentTimeMillis()).getTime());
         final long minutes = TimeUnit.MILLISECONDS.toMinutes(diffInMilliseconds);
@@ -98,4 +163,4 @@ public class User {
         this.tokenUsageDate = new Timestamp(System.currentTimeMillis());
         return true;
     }
-}
+}