java/src/main/com/google/appengine/api/datastore/Email.java

   1 /*
   2  * Copyright 2009 Google Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5  * use this file except in compliance with the License. You may obtain a copy of
   6  * the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13  * License for the specific language governing permissions and limitations under
  14  * the License.
  15  */
  16 package com.google.appengine.api.datastore;
  17
  18 import java.io.Serializable;
  19
  20 /**
  21  * An e-mail address datatype. Makes no attempt at validation.
  22  *
  23  * @see <a href="http://tools.ietf.org/html/rfc2822">RFC 2822</a>
  24  * for the e-mail address specification.
  25  */
  26 public final class Email implements Serializable, Comparable<Email> {
  27   static final long serialVersionUID = -4807513785819575482L;
  28
  29   private String email;
  30
  31   public Email(String email) {
  32     if (email == null) {
  33       throw new NullPointerException("email must not be null");
  34     }
  35     this.email = email;
  36   }
  37
  38   /**
  39    * This constructor exists for frameworks (e.g. Google Web Toolkit)
  40    * that require it for serialization purposes.  It should not be
  41    * called explicitly.
  42    */
  43   @SuppressWarnings("unused")
  44   private Email() {
  45     this.email = null;
  46   }
  47
  48   public String getEmail() {
  49     return email;
  50   }
  51
  52   @Override
  53   public int compareTo(Email e) {
  54     return email.compareTo(e.email);
  55   }
  56
  57   @Override
  58   public boolean equals(Object o) {
  59     if (this == o) {
  60       return true;
  61     }
  62     if (o == null || getClass() != o.getClass()) {
  63       return false;
  64     }
  65
  66     Email email1 = (Email) o;
  67
  68     if (!email.equals(email1.email)) {
  69       return false;
  70     }
  71
  72     return true;
  73   }
  74
  75   @Override
  76   public int hashCode() {
  77     return email.hashCode();
  78   }
  79 }