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.graph;
  24 
  25 import java.util.Map;
  26 import java.util.Set;
  27 
  28 import org.graalvm.compiler.api.collections.CollectionsProvider;
  29 
  30 /**
  31  * Extends {@link CollectionsProvider} with support for creating {@link Node} based collections.
  32  */
  33 public interface NodeCollectionsProvider extends CollectionsProvider {
  34 
  35     /**
  36      * Creates a set of {@link Node}s that uses reference-equality in place of object-equality when
  37      * comparing entries.
  38      */
  39     <E extends Node> Set<E> newNodeIdentitySet();
  40 
  41     /**
  42      * Creates a map whose keys are {@link Node}s that uses reference-equality in place of
  43      * object-equality when comparing keys. All {@link Node} keys must be in the same graph.
  44      */
  45     <K extends Node, V> Map<K, V> newNodeIdentityMap();
  46 
  47     /**
  48      * Creates a map whose keys are {@link Node}s that uses reference-equality in place of
  49      * object-equality when comparing keys. All {@link Node} keys must be in the same graph.
  50      */
  51     <K extends Node, V> Map<K, V> newNodeIdentityMap(int expectedMaxSize);
  52 
  53     /**
  54      * Creates a map whose keys are {@link Node}s that uses reference-equality in place of
  55      * object-equality when comparing keys. All {@link Node} keys must be in the same graph.
  56      *
  57      * @param initFrom the returned map is populated with the entries in this map
  58      */
  59     <K extends Node, V> Map<K, V> newNodeIdentityMap(Map<K, V> initFrom);
  60 }