View Javadoc

1   /*
2    * This file is part of Domingo
3    * an Open Source Java-API to Lotus Notes/Domino
4    * hosted at http://domingo.sourceforge.net
5    *
6    * Copyright (c) 2003-2007 Beck et al. projects GmbH Munich, Germany (http://www.bea.de)
7    *
8    * This library is free software; you can redistribute it and/or
9    * modify it under the terms of the GNU Lesser General Public
10   * License as published by the Free Software Foundation; either
11   * version 2.1 of the License, or (at your option) any later version.
12   *
13   * This library is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   * Lesser General Public License for more details.
17   *
18   * You should have received a copy of the GNU Lesser General Public
19   * License along with this library; if not, write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21   */
22  
23  package de.bea.domingo;
24  
25  import java.io.Serializable;
26  
27  /***
28   * Base interface for all concrete notes interfaces.
29   *
30   * <p>The Base class defines methods that are common to all the classes.
31   * User code should not directly access the Base class.</p>
32   *
33   * @author <a href=mailto:kriede@users.sourceforge.net>Kurt Riede</a>
34   */
35  public interface DBase extends Serializable {
36  
37      /***
38       * Returns a short description of an instance.
39       *
40       * @return short description of an instance
41       */
42      String toString();
43  
44      /***
45       * Indicates whether some other object is "equal to" this one.
46       *
47       * @param   object the reference object with which to compare.
48       * @return  <code>true</code> if this object is the same as the object
49       *          argument; <code>false</code> otherwise.
50       * @see     #hashCode()
51       * @see     java.lang.Object#hashCode()
52       * @see     java.lang.Object#equals(java.lang.Object)
53       * @see     java.util.Hashtable
54       */
55      boolean equals(Object object);
56  
57      /***
58       * Returns a hash code value for the object.
59       *
60       * @return  a hash code value for this object.
61       * @see     #equals(java.lang.Object)
62       * @see     java.lang.Object#hashCode()
63       * @see     java.lang.Object#equals(java.lang.Object)
64       * @see     java.util.Hashtable
65       */
66      int hashCode();
67  }