src/jdk.internal.vm.compiler/share/classes/org.graalvm.collections/src/org/graalvm/collections/UnmodifiableEconomicSet.java
author iveresov
Fri, 02 Feb 2018 17:28:17 -0800
changeset 48861 47f19ff9903c
permissions -rw-r--r--
8194819: Update Graal Reviewed-by: kvn
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
48861
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     1
/*
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     2
 * Copyright (c) 2017, 2017, Oracle and/or its affiliates. All rights reserved.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     4
 *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    10
 *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    15
 * accompanied this code).
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    16
 *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    20
 *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    23
 * questions.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    24
 */
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    25
package org.graalvm.collections;
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    26
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    27
/**
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    28
 * Unmodifiable memory efficient set data structure.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    29
 *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    30
 * @since 1.0
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    31
 */
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    32
public interface UnmodifiableEconomicSet<E> extends Iterable<E> {
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    33
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    34
    /**
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    35
     * Returns {@code true} if this set contains a mapping for the {@code element}.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    36
     *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    37
     * @since 1.0
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    38
     */
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    39
    boolean contains(E element);
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    40
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    41
    /**
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    42
     * Returns the number of elements in this set.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    43
     *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    44
     * @since 1.0
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    45
     */
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    46
    int size();
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    47
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    48
    /**
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    49
     * Returns {@code true} if this set contains no elements.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    50
     *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    51
     * @since 1.0
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    52
     */
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    53
    boolean isEmpty();
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    54
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    55
    /**
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    56
     * Stores all of the elements in this set into {@code target}. An
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    57
     * {@link UnsupportedOperationException} will be thrown if the length of {@code target} does not
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    58
     * match the size of this set.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    59
     *
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    60
     * @return an array containing all the elements in this set.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    61
     * @throws UnsupportedOperationException if the length of {@code target} does not equal the size
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    62
     *             of this set.
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    63
     * @since 1.0
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    64
     */
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    65
    default E[] toArray(E[] target) {
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    66
        if (target.length != size()) {
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    67
            throw new UnsupportedOperationException("Length of target array must equal the size of the set.");
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    68
        }
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    69
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    70
        int index = 0;
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    71
        for (E element : this) {
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    72
            target[index++] = element;
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    73
        }
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    74
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    75
        return target;
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    76
    }
47f19ff9903c 8194819: Update Graal
iveresov
parents:
diff changeset
    77
}