1 /*

     2  * Copyright (c) 2017, 2017, 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.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 package org.graalvm.collections;

    26 

    27 /**

    28  * Cursor to iterate over a map without changing its contents.

    29  *

    30  * @since 1.0

    31  */

    32 public interface UnmodifiableMapCursor<K, V> {

    33     /**

    34      * Advances to the next entry.

    35      *

    36      * @return {@code true} if a next entry exists, {@code false} if there is no next entry.

    37      * @since 1.0

    38      */

    39     boolean advance();

    40 

    41     /**

    42      * The key of the current entry.

    43      *

    44      * @since 1.0

    45      */

    46     K getKey();

    47 

    48     /**

    49      * The value of the current entry.

    50      *

    51      * @since 1.0

    52      */

    53     V getValue();

    54 }