Save This Page
Home » glassfish-v2ur2-b04-src » javax » mail » [javadoc | source]
    1   /*
    2    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
    3    *
    4    * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
    5    *
    6    * The contents of this file are subject to the terms of either the GNU
    7    * General Public License Version 2 only ("GPL") or the Common Development
    8    * and Distribution License("CDDL") (collectively, the "License").  You
    9    * may not use this file except in compliance with the License. You can obtain
   10    * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
   11    * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
   12    * language governing permissions and limitations under the License.
   13    *
   14    * When distributing the software, include this License Header Notice in each
   15    * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
   16    * Sun designates this particular file as subject to the "Classpath" exception
   17    * as provided by Sun in the GPL Version 2 section of the License file that
   18    * accompanied this code.  If applicable, add the following below the License
   19    * Header, with the fields enclosed by brackets [] replaced by your own
   20    * identifying information: "Portions Copyrighted [year]
   21    * [name of copyright owner]"
   22    *
   23    * Contributor(s):
   24    *
   25    * If you wish your version of this file to be governed by only the CDDL or
   26    * only the GPL Version 2, indicate your decision by adding "[Contributor]
   27    * elects to include this software in this distribution under the [CDDL or GPL
   28    * Version 2] license."  If you don't indicate a single choice of license, a
   29    * recipient has the option to distribute your version of this file under
   30    * either the CDDL, the GPL Version 2 or to extend the choice of license to
   31    * its licensees as provided above.  However, if you add GPL Version 2 code
   32    * and therefore, elected the GPL Version 2 license, then the option applies
   33    * only if the new code is made subject to such option by the copyright
   34    * holder.
   35    */
   36   
   37   /*
   38    * @(#)Address.java	1.10 07/05/04
   39    */
   40   
   41   package javax.mail;
   42   
   43   import java.io.Serializable;
   44   
   45   /**
   46    * This abstract class models the addresses in a message.
   47    * Subclasses provide specific implementations.  Subclasses
   48    * will typically be serializable so that (for example) the
   49    * use of Address objects in search terms can be serialized
   50    * along with the search terms.
   51    *
   52    * @author John Mani
   53    * @author Bill Shannon
   54    */
   55   
   56   public abstract class Address implements Serializable {
   57   
   58       private static final long serialVersionUID = -5822459626751992278L;
   59   
   60       /**
   61        * Return a type string that identifies this address type.
   62        *
   63        * @return	address type
   64        * @see	javax.mail.internet.InternetAddress
   65        */
   66       public abstract String getType();
   67   
   68       /**
   69        * Return a String representation of this address object.
   70        *
   71        * @return	string representation of this address
   72        */
   73       public abstract String toString();
   74   
   75       /**
   76        * The equality operator.  Subclasses should provide an
   77        * implementation of this method that supports value equality
   78        * (do the two Address objects represent the same destination?),
   79        * not object reference equality.  A subclass must also provide
   80        * a corresponding implementation of the <code>hashCode</code>
   81        * method that preserves the general contract of
   82        * <code>equals</code> and <code>hashCode</code> - objects that
   83        * compare as equal must have the same hashCode.
   84        *
   85        * @param	address	Address object
   86        */
   87       public abstract boolean equals(Object address);
   88   }

Save This Page
Home » glassfish-v2ur2-b04-src » javax » mail » [javadoc | source]