1 /*
   2  * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package org.graalvm.compiler.api.collections;
  24 
  25 import java.util.Map;
  26 import java.util.Set;
  27 
  28 /**
  29  * A factory for creating collections.
  30  */
  31 public interface CollectionsProvider {
  32 
  33     /**
  34      * Creates a set that uses reference-equality in place of object-equality when comparing
  35      * entries.
  36      */
  37     <E> Set<E> newIdentitySet();
  38 
  39     /**
  40      * Creates a map that uses reference-equality in place of object-equality when comparing keys.
  41      */
  42     <K, V> Map<K, V> newIdentityMap();
  43 
  44     /**
  45      * Creates a map that uses reference-equality in place of object-equality when comparing keys.
  46      *
  47      * @param expectedMaxSize the expected maximum size of the map
  48      */
  49     <K, V> Map<K, V> newIdentityMap(int expectedMaxSize);
  50 
  51     /**
  52      * Creates a map that uses reference-equality in place of object-equality when comparing keys.
  53      *
  54      * @param initFrom the returned map is populated with the entries in this map
  55      */
  56     <K, V> Map<K, V> newIdentityMap(Map<K, V> initFrom);
  57 }