drv.Map.drv Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* Copyright (C) 2002-2017 Sebastiano Vigna
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package PACKAGE;
import VALUE_PACKAGE.VALUE_COLLECTION;
import it.unimi.dsi.fastutil.objects.ObjectSet;
import it.unimi.dsi.fastutil.objects.ObjectIterator;
import java.util.Map;
/** A type-specific {@link Map}; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.
*
* Besides extending the corresponding type-specific {@linkplain it.unimi.dsi.fastutil.Function function}, this interface strengthens {@link #entrySet()},
* {@link #keySet()} and {@link #values()}. Maps returning entry sets of type {@link FastEntrySet} support also fast iteration.
*
*
A submap or subset may or may not have an
* independent default return value (which however must be initialized to the
* default return value of the originator).
*
* @see Map
*/
public interface MAP KEY_VALUE_GENERIC extends FUNCTION KEY_VALUE_GENERIC, Map {
/** An entry set providing fast iteration.
*
* In some cases (e.g., hash-based classes) iteration over an entry set requires the creation
* of a large number of {@link java.util.Map.Entry} objects. Some fastutil
* maps might return {@linkplain #entrySet() entry set} objects of type FastEntrySet: in this case, {@link #fastIterator() fastIterator()}
* will return an iterator that is guaranteed not to create a large number of objects, possibly
* by returning always the same entry (of course, mutated).
*/
public interface FastEntrySet KEY_VALUE_GENERIC extends ObjectSet {
/** Returns a fast iterator over this entry set; the iterator might return always the same entry object, suitably mutated.
*
* @return a fast iterator over this entry set; the iterator might return always the same {@link java.util.Map.Entry} object, suitably mutated.
*/
public ObjectIterator fastIterator();
}
/** Returns a type-specific set view of the mappings contained in this map.
*
* This method is necessary because there is no inheritance along
* type parameters: it is thus impossible to strengthen {@link #entrySet()}
* so that it returns an {@link it.unimi.dsi.fastutil.objects.ObjectSet}
* of type-specific entries (the latter makes it possible to
* access keys and values with type-specific methods).
*
* @return a type-specific set view of the mappings contained in this map.
* @see Map#entrySet()
*/
ObjectSet ENTRYSET();
#if KEYS_PRIMITIVE || VALUES_PRIMITIVE
/** Returns a set view of the mappings contained in this map.
* Note that this specification strengthens the one given in {@link Map#entrySet()}.
*
* @return a set view of the mappings contained in this map.
* @see Map#entrySet()
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
ObjectSet> entrySet();
/** {@inheritDoc}
* This method specification is a workaround for
* bug 8177440.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
VALUE_GENERIC_CLASS put(KEY_GENERIC_CLASS key, VALUE_GENERIC_CLASS value);
/** {@inheritDoc}
*
This method specification is a workaround for
* bug 8177440.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
VALUE_GENERIC_CLASS get(Object key);
/** {@inheritDoc}
*
This method specification is a workaround for
* bug 8177440.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
VALUE_GENERIC_CLASS remove(Object key);
#endif
/** {@inheritDoc}
*
Note that this specification strengthens the one given in {@link Map#keySet()}.
* @return a set view of the keys contained in this map.
* @see Map#keySet()
*/
@Override
SET KEY_GENERIC keySet();
/** {@inheritDoc}
*
Note that this specification strengthens the one given in {@link Map#values()}.
* @return a set view of the values contained in this map.
* @see Map#values()
*/
@Override
VALUE_COLLECTION VALUE_GENERIC values();
#if VALUES_PRIMITIVE
/** Returns {@code true} if this map maps one or more keys to the
* specified value.
* @see Map#containsValue(Object)
*/
boolean containsValue(VALUE_TYPE value);
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
boolean containsValue(Object value);
#endif
/** A type-specific {@link java.util.Map.Entry}; provides some additional methods
* that use polymorphism to avoid (un)boxing.
*
* @see java.util.Map.Entry
*/
interface Entry KEY_VALUE_GENERIC extends Map.Entry {
#if KEYS_PRIMITIVE
/** Returns the key corresponding to this entry.
* @see java.util.Map.Entry#getKey()
*/
KEY_TYPE ENTRY_GET_KEY();
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
KEY_GENERIC_CLASS getKey();
#endif
#if VALUES_PRIMITIVE
/** Returns the value corresponding to this entry.
* @see java.util.Map.Entry#getValue()
*/
VALUE_TYPE ENTRY_GET_VALUE();
/** Replaces the value corresponding to this entry with the specified value (optional operation).
* @see java.util.Map.Entry#setValue(Object)
*/
VALUE_TYPE setValue(VALUE_TYPE value);
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
VALUE_GENERIC_CLASS getValue();
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
VALUE_GENERIC_CLASS setValue(VALUE_GENERIC_CLASS value);
#endif
}
}