it.unimi.dsi.fastutil.ints.Int2ObjectSortedMaps Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/* Generic definitions */
/* Assertions (useful to generate conditional code) */
/* Current type and class (and size, if applicable) */
/* Value methods */
/* Interfaces (keys) */
/* Interfaces (values) */
/* Abstract implementations (keys) */
/* Abstract implementations (values) */
/* Static containers (keys) */
/* Static containers (values) */
/* Implementations */
/* Synchronized wrappers */
/* Unmodifiable wrappers */
/* Other wrappers */
/* Methods (keys) */
/* Methods (values) */
/* Methods (keys/values) */
/* Methods that have special names depending on keys (but the special names depend on values) */
/* Equality */
/* Object/Reference-only definitions (keys) */
/* Primitive-type-only definitions (keys) */
/* Object/Reference-only definitions (values) */
/*
* Copyright (C) 2002-2016 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 it.unimi.dsi.fastutil.ints;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectSortedSets;
import java.util.Comparator;
import java.util.Map;
import java.util.SortedMap;
import java.util.NoSuchElementException;
/**
* A class providing static methods and objects that do useful things with
* type-specific sorted maps.
*
* @see java.util.Collections
*/
public class Int2ObjectSortedMaps {
private Int2ObjectSortedMaps() {
}
/**
* Returns a comparator for entries based on a given comparator on keys.
*
* @param comparator
* a comparator on keys.
* @return the associated comparator on entries.
*/
public static Comparator> entryComparator(
final IntComparator comparator) {
return new Comparator>() {
public int compare(Map.Entry x, Map.Entry y) {
return comparator.compare(x.getKey(), y.getKey());
}
};
}
/**
* An immutable class representing an empty type-specific sorted map.
*
*
* This class may be useful to implement your own in case you subclass a
* type-specific sorted map.
*/
public static class EmptySortedMap extends Int2ObjectMaps.EmptyMap
implements
Int2ObjectSortedMap,
java.io.Serializable,
Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptySortedMap() {
}
public IntComparator comparator() {
return null;
}
@SuppressWarnings("unchecked")
public ObjectSortedSet> int2ObjectEntrySet() {
return ObjectSortedSets.EMPTY_SET;
}
@SuppressWarnings("unchecked")
public ObjectSortedSet> entrySet() {
return ObjectSortedSets.EMPTY_SET;
}
public IntSortedSet keySet() {
return IntSortedSets.EMPTY_SET;
}
@SuppressWarnings("unchecked")
public Int2ObjectSortedMap subMap(final int from, final int to) {
return EMPTY_MAP;
}
@SuppressWarnings("unchecked")
public Int2ObjectSortedMap headMap(final int to) {
return EMPTY_MAP;
}
@SuppressWarnings("unchecked")
public Int2ObjectSortedMap tailMap(final int from) {
return EMPTY_MAP;
}
public int firstIntKey() {
throw new NoSuchElementException();
}
public int lastIntKey() {
throw new NoSuchElementException();
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2ObjectSortedMap headMap(Integer oto) {
return headMap(((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2ObjectSortedMap tailMap(Integer ofrom) {
return tailMap(((ofrom).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2ObjectSortedMap subMap(Integer ofrom, Integer oto) {
return subMap(((ofrom).intValue()), ((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer firstKey() {
return (Integer.valueOf(firstIntKey()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer lastKey() {
return (Integer.valueOf(lastIntKey()));
}
}
/**
* An empty sorted map (immutable). It is serializable and cloneable.
*/
@SuppressWarnings("rawtypes")
public static final EmptySortedMap EMPTY_MAP = new EmptySortedMap();
/**
* Return an empty sorted map (immutable). It is serializable and cloneable.
*
*
* This method provides a typesafe access to {@link #EMPTY_MAP}.
*
* @return an empty sorted map (immutable).
*/
@SuppressWarnings("unchecked")
public static Int2ObjectSortedMap emptyMap() {
return EMPTY_MAP;
}
/**
* An immutable class representing a type-specific singleton sorted map.
*
*
* This class may be useful to implement your own in case you subclass a
* type-specific sorted map.
*/
public static class Singleton extends Int2ObjectMaps.Singleton
implements
Int2ObjectSortedMap,
java.io.Serializable,
Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected final IntComparator comparator;
protected Singleton(final int key, final V value,
IntComparator comparator) {
super(key, value);
this.comparator = comparator;
}
protected Singleton(final int key, final V value) {
this(key, value, null);
}
final int compare(final int k1, final int k2) {
return comparator == null
? (Integer.compare((k1), (k2)))
: comparator.compare(k1, k2);
}
public IntComparator comparator() {
return comparator;
}
public ObjectSortedSet> int2ObjectEntrySet() {
if (entries == null)
entries = ObjectSortedSets
.singleton(
(Int2ObjectMap.Entry) new SingletonEntry(),
(Comparator>) entryComparator(comparator));
return (ObjectSortedSet>) entries;
}
@SuppressWarnings({"rawtypes", "unchecked"})
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) int2ObjectEntrySet();
}
public IntSortedSet keySet() {
if (keys == null)
keys = IntSortedSets.singleton(key, comparator);
return (IntSortedSet) keys;
}
@SuppressWarnings("unchecked")
public Int2ObjectSortedMap subMap(final int from, final int to) {
if (compare(from, key) <= 0 && compare(key, to) < 0)
return this;
return EMPTY_MAP;
}
@SuppressWarnings("unchecked")
public Int2ObjectSortedMap headMap(final int to) {
if (compare(key, to) < 0)
return this;
return EMPTY_MAP;
}
@SuppressWarnings("unchecked")
public Int2ObjectSortedMap tailMap(final int from) {
if (compare(from, key) <= 0)
return this;
return EMPTY_MAP;
}
public int firstIntKey() {
return key;
}
public int lastIntKey() {
return key;
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2ObjectSortedMap headMap(Integer oto) {
return headMap(((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2ObjectSortedMap tailMap(Integer ofrom) {
return tailMap(((ofrom).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Int2ObjectSortedMap subMap(Integer ofrom, Integer oto) {
return subMap(((ofrom).intValue()), ((oto).intValue()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer firstKey() {
return (Integer.valueOf(firstIntKey()));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Integer lastKey() {
return (Integer.valueOf(lastIntKey()));
}
}
/**
* Returns a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2ObjectSortedMap singleton(final Integer key,
V value) {
return new Singleton(((key).intValue()), (value));
}
/**
* RETURNS a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @param comparator
* the comparator to use in the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2ObjectSortedMap singleton(final Integer key,
V value, IntComparator comparator) {
return new Singleton(((key).intValue()), (value), comparator);
}
/**
* Returns a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2ObjectSortedMap singleton(final int key,
final V value) {
return new Singleton(key, value);
}
/**
* Returns a type-specific immutable sorted map containing only the
* specified pair. The returned sorted map is serializable and cloneable.
*
*
* Note that albeit the returned map is immutable, its default return value
* may be changed.
*
* @param key
* the only key of the returned sorted map.
* @param value
* the only value of the returned sorted map.
* @param comparator
* the comparator to use in the returned sorted map.
* @return a type-specific immutable sorted map containing just the pair
* <key,value>.
*/
public static Int2ObjectSortedMap singleton(final int key,
final V value, IntComparator comparator) {
return new Singleton(key, value, comparator);
}
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap
extends
Int2ObjectMaps.SynchronizedMap
implements
Int2ObjectSortedMap,
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Int2ObjectSortedMap sortedMap;
protected SynchronizedSortedMap(final Int2ObjectSortedMap m,
final Object sync) {
super(m, sync);
sortedMap = m;
}
protected SynchronizedSortedMap(final Int2ObjectSortedMap m) {
super(m);
sortedMap = m;
}
public IntComparator comparator() {
synchronized (sync) {
return sortedMap.comparator();
}
}
public ObjectSortedSet> int2ObjectEntrySet() {
if (entries == null)
entries = ObjectSortedSets.synchronize(
sortedMap.int2ObjectEntrySet(), sync);
return (ObjectSortedSet>) entries;
}
@SuppressWarnings({"rawtypes", "unchecked"})
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) int2ObjectEntrySet();
}
public IntSortedSet keySet() {
if (keys == null)
keys = IntSortedSets.synchronize(sortedMap.keySet(), sync);
return (IntSortedSet) keys;
}
public Int2ObjectSortedMap subMap(final int from, final int to) {
return new SynchronizedSortedMap(sortedMap.subMap(from, to),
sync);
}
public Int2ObjectSortedMap headMap(final int to) {
return new SynchronizedSortedMap(sortedMap.headMap(to), sync);
}
public Int2ObjectSortedMap tailMap(final int from) {
return new SynchronizedSortedMap(sortedMap.tailMap(from), sync);
}
public int firstIntKey() {
synchronized (sync) {
return sortedMap.firstIntKey();
}
}
public int lastIntKey() {
synchronized (sync) {
return sortedMap.lastIntKey();
}
}
public Integer firstKey() {
synchronized (sync) {
return sortedMap.firstKey();
}
}
public Integer lastKey() {
synchronized (sync) {
return sortedMap.lastKey();
}
}
public Int2ObjectSortedMap subMap(final Integer from,
final Integer to) {
return new SynchronizedSortedMap(sortedMap.subMap(from, to),
sync);
}
public Int2ObjectSortedMap headMap(final Integer to) {
return new SynchronizedSortedMap(sortedMap.headMap(to), sync);
}
public Int2ObjectSortedMap tailMap(final Integer from) {
return new SynchronizedSortedMap(sortedMap.tailMap(from), sync);
}
}
/**
* Returns a synchronized type-specific sorted map backed by the given
* type-specific sorted map.
*
* @param m
* the sorted map to be wrapped in a synchronized sorted map.
* @return a synchronized view of the specified sorted map.
* @see java.util.Collections#synchronizedSortedMap(SortedMap)
*/
public static Int2ObjectSortedMap synchronize(
final Int2ObjectSortedMap m) {
return new SynchronizedSortedMap(m);
}
/**
* Returns a synchronized type-specific sorted map backed by the given
* type-specific sorted map, using an assigned object to synchronize.
*
* @param m
* the sorted map to be wrapped in a synchronized sorted map.
* @param sync
* an object that will be used to synchronize the access to the
* sorted sorted map.
* @return a synchronized view of the specified sorted map.
* @see java.util.Collections#synchronizedSortedMap(SortedMap)
*/
public static Int2ObjectSortedMap synchronize(
final Int2ObjectSortedMap m, final Object sync) {
return new SynchronizedSortedMap(m, sync);
}
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap
extends
Int2ObjectMaps.UnmodifiableMap
implements
Int2ObjectSortedMap,
java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final Int2ObjectSortedMap sortedMap;
protected UnmodifiableSortedMap(final Int2ObjectSortedMap m) {
super(m);
sortedMap = m;
}
public IntComparator comparator() {
return sortedMap.comparator();
}
public ObjectSortedSet> int2ObjectEntrySet() {
if (entries == null)
entries = ObjectSortedSets.unmodifiable(sortedMap
.int2ObjectEntrySet());
return (ObjectSortedSet>) entries;
}
@SuppressWarnings({"rawtypes", "unchecked"})
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) int2ObjectEntrySet();
}
public IntSortedSet keySet() {
if (keys == null)
keys = IntSortedSets.unmodifiable(sortedMap.keySet());
return (IntSortedSet) keys;
}
public Int2ObjectSortedMap subMap(final int from, final int to) {
return new UnmodifiableSortedMap(sortedMap.subMap(from, to));
}
public Int2ObjectSortedMap headMap(final int to) {
return new UnmodifiableSortedMap(sortedMap.headMap(to));
}
public Int2ObjectSortedMap tailMap(final int from) {
return new UnmodifiableSortedMap(sortedMap.tailMap(from));
}
public int firstIntKey() {
return sortedMap.firstIntKey();
}
public int lastIntKey() {
return sortedMap.lastIntKey();
}
public Integer firstKey() {
return sortedMap.firstKey();
}
public Integer lastKey() {
return sortedMap.lastKey();
}
public Int2ObjectSortedMap subMap(final Integer from,
final Integer to) {
return new UnmodifiableSortedMap(sortedMap.subMap(from, to));
}
public Int2ObjectSortedMap headMap(final Integer to) {
return new UnmodifiableSortedMap(sortedMap.headMap(to));
}
public Int2ObjectSortedMap tailMap(final Integer from) {
return new UnmodifiableSortedMap(sortedMap.tailMap(from));
}
}
/**
* Returns an unmodifiable type-specific sorted map backed by the given
* type-specific sorted map.
*
* @param m
* the sorted map to be wrapped in an unmodifiable sorted map.
* @return an unmodifiable view of the specified sorted map.
* @see java.util.Collections#unmodifiableSortedMap(SortedMap)
*/
public static Int2ObjectSortedMap unmodifiable(
final Int2ObjectSortedMap m) {
return new UnmodifiableSortedMap(m);
}
}