src/org/mxchange/jusercore/model/email_address/EmailAddressChange.java

   1 /*
   2  * Copyright (C) 2016 quix0r
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jusercore.model.email_address;
  18
  19 import java.util.Calendar;
  20 import java.util.Objects;
  21 import javax.persistence.Basic;
  22 import javax.persistence.CascadeType;
  23 import javax.persistence.Column;
  24 import javax.persistence.Entity;
  25 import javax.persistence.EnumType;
  26 import javax.persistence.Enumerated;
  27 import javax.persistence.GeneratedValue;
  28 import javax.persistence.GenerationType;
  29 import javax.persistence.Id;
  30 import javax.persistence.Index;
  31 import javax.persistence.OneToOne;
  32 import javax.persistence.Table;
  33 import javax.persistence.Temporal;
  34 import javax.persistence.TemporalType;
  35 import org.mxchange.jusercore.model.email_address.status.EmailChangeStatus;
  36 import org.mxchange.jusercore.model.user.LoginUser;
  37 import org.mxchange.jusercore.model.user.User;
  38
  39 /**
  40  * A POJO for changing email addresses.
  41  * <p>
  42  * @author Roland Haeder<roland@mxchange.org>
  43  */
  44 @Entity (name = "email_changes")
  45 @Table (
  46                 name = "email_changes",
  47                 indexes = {
  48                         @Index (name = "email_change_user", columnList = "email_change_user")
  49                 }
  50 )
  51 public class EmailAddressChange implements ChangeableEmailAddress, Comparable<ChangeableEmailAddress> {
  52
  53         /**
  54          * Serial number
  55          */
  56         private static final long serialVersionUID = 398_459_287_176_139L;
  57
  58         /**
  59          * Email address to change to
  60          */
  61         @Basic (optional = false)
  62         @Column (name = "email_address", length = 100, nullable = false, updatable = false)
  63         private String emailAddress;
  64
  65         /**
  66          * Timestamp when this change has been added
  67          */
  68         @Basic (optional = false)
  69         @Temporal (TemporalType.TIMESTAMP)
  70         @Column (name = "email_change_created", nullable = false, updatable = false)
  71         private Calendar emailChangeCreated;
  72
  73         /**
  74          * Timestamp when this change has been done or undone
  75          */
  76         @Basic (optional = false)
  77         @Temporal (TemporalType.TIMESTAMP)
  78         @Column (name = "email_change_done", nullable = false, updatable = false)
  79         private Calendar emailChangeDone;
  80
  81         /**
  82          * Email change id
  83          */
  84         @Id
  85         @GeneratedValue (strategy = GenerationType.IDENTITY)
  86         @Column (name = "email_change_id", length = 20, nullable = false, updatable = false)
  87         private Long emailChangeId;
  88
  89         /**
  90          * Email change status
  91          */
  92         @Basic (optional = false)
  93         @Column (name = "email_change_status", nullable = false, updatable = false)
  94         @Enumerated (EnumType.STRING)
  95         private EmailChangeStatus emailChangeStatus;
  96
  97         /**
  98          * User initiating the email change
  99          */
 100         @Basic (optional = false)
 101         @Column (name = "email_change_user_id", length = 20, nullable = false, updatable = false)
 102         @OneToOne (targetEntity = LoginUser.class, optional = false, cascade = CascadeType.REFRESH)
 103         private User emailChangeUser;
 104
 105         /**
 106          * Default constructor
 107          */
 108         public EmailAddressChange () {
 109                 // Set default email change status
 110                 this.emailChangeStatus = EmailChangeStatus.NEW;
 111         }
 112
 113         @Override
 114         public int compareTo (final ChangeableEmailAddress emailAddress) {
 115                 throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
 116         }
 117
 118         @Override
 119         public boolean equals (final Object object) {
 120                 if (this == object) {
 121                         return true;
 122                 } else if (object == null) {
 123                         return false;
 124                 } else if (this.getClass() != object.getClass()) {
 125                         return false;
 126                 }
 127
 128                 final ChangeableEmailAddress otherEmail = (ChangeableEmailAddress) object;
 129
 130                 if (!Objects.equals(this.getEmailChangeId(), otherEmail.getEmailChangeId())) {
 131                         return false;
 132                 }
 133
 134                 return Objects.equals(this.getEmailChangeUser(), otherEmail.getEmailChangeUser());
 135         }
 136
 137         @Override
 138         public int hashCode () {
 139                 int hash = 5;
 140                 hash = 71 * hash + Objects.hashCode(this.emailChangeId);
 141                 hash = 71 * hash + Objects.hashCode(this.emailChangeUser);
 142                 return hash;
 143         }
 144
 145         @Override
 146         public String getEmailAddress () {
 147                 return this.emailAddress;
 148         }
 149
 150         @Override
 151         public void setEmailAddress (final String emailAddress) {
 152                 this.emailAddress = emailAddress;
 153         }
 154
 155         @Override
 156         public Calendar getEmailChangeCreated () {
 157                 return this.emailChangeCreated;
 158         }
 159
 160         @Override
 161         public void setEmailChangeCreated (final Calendar emailChangeCreated) {
 162                 this.emailChangeCreated = emailChangeCreated;
 163         }
 164
 165         @Override
 166         public Calendar getEmailChangeDone () {
 167                 return this.emailChangeDone;
 168         }
 169
 170         @Override
 171         public void setEmailChangeDone (final Calendar emailChangeDone) {
 172                 this.emailChangeDone = emailChangeDone;
 173         }
 174
 175         @Override
 176         public Long getEmailChangeId () {
 177                 return this.emailChangeId;
 178         }
 179
 180         @Override
 181         public void setEmailChangeId (final Long emailChangeId) {
 182                 this.emailChangeId = emailChangeId;
 183         }
 184
 185         @Override
 186         public EmailChangeStatus getEmailChangeStatus () {
 187                 return this.emailChangeStatus;
 188         }
 189
 190         @Override
 191         public void setEmailChangeStatus (final EmailChangeStatus emailChangeStatus) {
 192                 this.emailChangeStatus = emailChangeStatus;
 193         }
 194
 195         @Override
 196         public User getEmailChangeUser () {
 197                 return this.emailChangeUser;
 198         }
 199
 200         @Override
 201         public void setEmailChangeUser (final User emailChangeUser) {
 202                 this.emailChangeUser = emailChangeUser;
 203         }
 204
 205 }