User.java

package me.moodcat.database.entities;

import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * User entity.
 */
@Data
@Entity
@Table(name = "users")
@EqualsAndHashCode(of = {
        "id"
})
public class User {

    private static final int AVATER_URL_MAX_LENGTH = 255;

    /**
     * The unique id of the user.
     *
     * @param id
     *            The new Id to set.
     * @return The id of the user.
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id", nullable = false)
    private Integer id;

    /**
     * The unique id of the user.
     *
     * @param id
     *            The new Id to set.
     * @return The id of the user.
     */
    @Column(name = "soundCloudUserId", nullable = true, unique = true)
    private Integer soundCloudUserId;

    /**
     * The name of this user.
     *
     * @param name
     *            The name to set.
     * @return The name of this user.
     */
    @Column(name = "name", nullable = false, unique = true)
    private String name;

    /**
     * The avatar of this user.
     *
     * @param avatarUrl
     *            The avatar to set.
     * @return The avatar of this user.
     */
    @Column(name = "avatar_url", nullable = true, unique = false, length = AVATER_URL_MAX_LENGTH)
    private String avatarUrl;

    /**
     * The amount of points the user has collected.
     * 
     * @return The amount of points the user has
     */
    @Column(name = "points")
    private int points;

    /**
     * SoundCloud OAuth access token.
     * See: https://developers.soundcloud.com/docs/api/reference#token
     */
    @Basic(fetch = FetchType.LAZY)
    @Column(name = "access_token", nullable = true)
    private String accessToken;

    /**
     * Updates the points for the user.
     * 
     * @param addition
     *            The amount of points the user gained
     */
    public void increment(final Integer addition) {
        this.setPoints(this.getPoints() + addition);
    }

}