001/*
002 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.api.collections;
024
025import java.util.*;
026
027/**
028 * A factory for creating collections.
029 */
030public interface CollectionsProvider {
031
032    /**
033     * Creates a set that uses reference-equality in place of object-equality when comparing
034     * entries.
035     */
036    <E> Set<E> newIdentitySet();
037
038    /**
039     * Creates a map that uses reference-equality in place of object-equality when comparing keys.
040     */
041    <K, V> Map<K, V> newIdentityMap();
042
043    /**
044     * Creates a map that uses reference-equality in place of object-equality when comparing keys.
045     *
046     * @param expectedMaxSize the expected maximum size of the map
047     */
048    <K, V> Map<K, V> newIdentityMap(int expectedMaxSize);
049
050    /**
051     * Creates a map that uses reference-equality in place of object-equality when comparing keys.
052     *
053     * @param initFrom the returned map is populated with the entries in this map
054     */
055    <K, V> Map<K, V> newIdentityMap(Map<K, V> initFrom);
056}