org.graalvm.collections.EconomicMap Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of graal-sdk Show documentation
Show all versions of graal-sdk Show documentation
GraalVM is an ecosystem for compiling and running applications written in multiple languages.
GraalVM removes the isolation between programming languages and enables interoperability in a shared runtime.
/*
* Copyright (c) 2017, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.graalvm.collections;
import java.util.Iterator;
import java.util.Map;
import java.util.function.BiFunction;
/**
* Memory efficient map data structure.
*
* @since 1.0
*/
public interface EconomicMap extends UnmodifiableEconomicMap {
/**
* Associates {@code value} with {@code key} in this map. If the map previously contained a
* mapping for {@code key}, the old value is replaced by {@code value}.
*
* @return the previous value associated with {@code key}, or {@code null} if there was no
* mapping for {@code key}.
* @since 1.0
*/
V put(K key, V value);
/**
* Copies all of the mappings from {@code other} to this map.
*
* @since 1.0
*/
default void putAll(EconomicMap other) {
MapCursor e = other.getEntries();
while (e.advance()) {
put(e.getKey(), e.getValue());
}
}
/**
* Copies all of the mappings from {@code other} to this map.
*
* @since 1.0
*/
default void putAll(UnmodifiableEconomicMap other) {
UnmodifiableMapCursor entry = other.getEntries();
while (entry.advance()) {
put(entry.getKey(), entry.getValue());
}
}
/**
* Removes all of the mappings from this map. The map will be empty after this call returns.
*
* @since 1.0
*/
void clear();
/**
* Removes the mapping for {@code key} from this map if it is present. The map will not contain
* a mapping for {@code key} once the call returns.
*
* @return the previous value associated with {@code key}, or {@code null} if there was no
* mapping for {@code key}.
* @since 1.0
*/
V removeKey(K key);
/**
* Returns a {@link MapCursor} view of the mappings contained in this map.
*
* @since 1.0
*/
@Override
MapCursor getEntries();
/**
* Replaces each entry's value with the result of invoking {@code function} on that entry until
* all entries have been processed or the function throws an exception. Exceptions thrown by the
* function are relayed to the caller.
*
* @since 1.0
*/
void replaceAll(BiFunction function);
/**
* Creates a new map that guarantees insertion order on the key set with the default
* {@link Equivalence#DEFAULT} comparison strategy for keys.
*
* @since 1.0
*/
static EconomicMap create() {
return EconomicMap.create(Equivalence.DEFAULT);
}
/**
* Creates a new map that guarantees insertion order on the key set with the default
* {@link Equivalence#DEFAULT} comparison strategy for keys and initializes with a specified
* capacity.
*
* @since 1.0
*/
static EconomicMap create(int initialCapacity) {
return EconomicMap.create(Equivalence.DEFAULT, initialCapacity);
}
/**
* Creates a new map that guarantees insertion order on the key set with the given comparison
* strategy for keys.
*
* @since 1.0
*/
static EconomicMap create(Equivalence strategy) {
return EconomicMapImpl.create(strategy, false);
}
/**
* Creates a new map that guarantees insertion order on the key set with the default
* {@link Equivalence#DEFAULT} comparison strategy for keys and copies all elements from the
* specified existing map.
*
* @since 1.0
*/
static EconomicMap create(UnmodifiableEconomicMap m) {
return EconomicMap.create(Equivalence.DEFAULT, m);
}
/**
* Creates a new map that guarantees insertion order on the key set and copies all elements from
* the specified existing map.
*
* @since 1.0
*/
static EconomicMap create(Equivalence strategy, UnmodifiableEconomicMap m) {
return EconomicMapImpl.create(strategy, m, false);
}
/**
* Creates a new map that guarantees insertion order on the key set and initializes with a
* specified capacity.
*
* @since 1.0
*/
static EconomicMap create(Equivalence strategy, int initialCapacity) {
return EconomicMapImpl.create(strategy, initialCapacity, false);
}
/**
* Wraps an existing {@link Map} as an {@link EconomicMap}.
*
* @since 1.0
*/
static EconomicMap wrapMap(Map map) {
return new EconomicMap() {
@Override
public V get(K key) {
V result = map.get(key);
return result;
}
@Override
public V put(K key, V value) {
V result = map.put(key, value);
return result;
}
@Override
public int size() {
int result = map.size();
return result;
}
@Override
public boolean containsKey(K key) {
return map.containsKey(key);
}
@Override
public void clear() {
map.clear();
}
@Override
public V removeKey(K key) {
V result = map.remove(key);
return result;
}
@Override
public Iterable getValues() {
return map.values();
}
@Override
public Iterable getKeys() {
return map.keySet();
}
@Override
public boolean isEmpty() {
return map.isEmpty();
}
@Override
public MapCursor getEntries() {
Iterator> iterator = map.entrySet().iterator();
return new MapCursor() {
private Map.Entry current;
@Override
public boolean advance() {
boolean result = iterator.hasNext();
if (result) {
current = iterator.next();
}
return result;
}
@Override
public K getKey() {
return current.getKey();
}
@Override
public V getValue() {
return current.getValue();
}
@Override
public void remove() {
iterator.remove();
}
};
}
@Override
public void replaceAll(BiFunction function) {
map.replaceAll(function);
}
};
}
}