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.graph;
024
025import java.util.*;
026
027import com.oracle.graal.api.collections.*;
028
029/**
030 * Extends {@link CollectionsProvider} with support for creating {@link Node} based collections.
031 */
032public interface NodeCollectionsProvider extends CollectionsProvider {
033
034    /**
035     * Creates a set of {@link Node}s that uses reference-equality in place of object-equality when
036     * comparing entries.
037     */
038    <E extends Node> Set<E> newNodeIdentitySet();
039
040    /**
041     * Creates a map whose keys are {@link Node}s that uses reference-equality in place of
042     * object-equality when comparing keys. All {@link Node} keys must be in the same graph.
043     */
044    <K extends Node, V> Map<K, V> newNodeIdentityMap();
045
046    /**
047     * Creates a map whose keys are {@link Node}s that uses reference-equality in place of
048     * object-equality when comparing keys. All {@link Node} keys must be in the same graph.
049     */
050    <K extends Node, V> Map<K, V> newNodeIdentityMap(int expectedMaxSize);
051
052    /**
053     * Creates a map whose keys are {@link Node}s that uses reference-equality in place of
054     * object-equality when comparing keys. All {@link Node} keys must be in the same graph.
055     *
056     * @param initFrom the returned map is populated with the entries in this map
057     */
058    <K extends Node, V> Map<K, V> newNodeIdentityMap(Map<K, V> initFrom);
059}