xpcom/ds/nsIHashable.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla XPCOM.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Benjamin Smedberg <benjamin@smedbergs.us>.
  18  *
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Mozilla Foundation <http://www.mozilla.org/>. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 /**
  41  * Represents an object that can be stored in a hashtable.
  42  *
  43  * @status FROZEN - This interface will not change in the Mozilla 1.x lifetime
  44  */
  45 [scriptable, uuid(17e595fa-b57a-4933-bd0f-b1812e8ab188)]
  46 interface nsIHashable : nsISupports
  47 {
  48   /**
  49    * Is this object the equivalent of the other object?
  50    */
  51   boolean equals(in nsIHashable aOther);
  52
  53   /**
  54    * A generated hashcode for this object. Objects that are equivalent
  55    * must have the same hash code. Getting this property should never
  56    * throw an exception!
  57    */
  58   readonly attribute unsigned long hashCode;
  59 };