/*
	* Copyright (C) 2002-2019 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.ObjectBidirectionalIterable;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import it.unimi.dsi.fastutil.objects.ObjectSortedSets;
import it.unimi.dsi.fastutil.ints.Int2ByteSortedMap.FastSortedEntrySet;
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 Also:
  • Collections
/** * A class providing static methods and objects that do useful things with * type-specific sorted maps. * * @see java.util.Collections */
public final class Int2ByteSortedMaps { private Int2ByteSortedMaps() { }
Returns a comparator for entries based on a given comparator on keys.
Params:
  • comparator – a comparator on keys.
Returns:the associated comparator on entries.
/** * 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<? super Map.Entry<Integer, ?>> entryComparator(final IntComparator comparator) { return (Comparator<Map.Entry<Integer, ?>>) (x, y) -> comparator.compare((x.getKey()).intValue(), (y.getKey()).intValue()); }
Returns a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
Params:
  • map – a map from which we will try to extract a (fast) bidirectional iterator on the entry set.
Returns:a bidirectional iterator on the entry set of the given map that will be fast, if possible.
Since:8.0.0
/** * Returns a bidirectional iterator that will be {@linkplain FastSortedEntrySet * fast}, if possible, on the {@linkplain Map#entrySet() entry set} of the * provided {@code map}. * * @param map * a map from which we will try to extract a (fast) bidirectional * iterator on the entry set. * @return a bidirectional iterator on the entry set of the given map that will * be fast, if possible. * @since 8.0.0 */
public static ObjectBidirectionalIterator<Int2ByteMap.Entry> fastIterator(Int2ByteSortedMap map) { final ObjectSortedSet<Int2ByteMap.Entry> entries = map.int2ByteEntrySet(); return entries instanceof Int2ByteSortedMap.FastSortedEntrySet ? ((Int2ByteSortedMap.FastSortedEntrySet) entries).fastIterator() : entries.iterator(); }
Returns an iterable yielding a bidirectional iterator that will be fast, if possible, on the entry set of the provided map.
Params:
  • map – a map from which we will try to extract an iterable yielding a (fast) bidirectional iterator on the entry set.
Returns:an iterable yielding a bidirectional iterator on the entry set of the given map that will be fast, if possible.
Since:8.0.0
/** * Returns an iterable yielding a bidirectional iterator that will be * {@linkplain FastSortedEntrySet fast}, if possible, on the * {@linkplain Map#entrySet() entry set} of the provided {@code map}. * * @param map * a map from which we will try to extract an iterable yielding a * (fast) bidirectional iterator on the entry set. * @return an iterable yielding a bidirectional iterator on the entry set of the * given map that will be fast, if possible. * @since 8.0.0 */
public static ObjectBidirectionalIterable<Int2ByteMap.Entry> fastIterable(Int2ByteSortedMap map) { final ObjectSortedSet<Int2ByteMap.Entry> entries = map.int2ByteEntrySet(); return entries instanceof Int2ByteSortedMap.FastSortedEntrySet ? ((Int2ByteSortedMap.FastSortedEntrySet) entries)::fastIterator : entries; }
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.

/** * An immutable class representing an empty type-specific sorted map. * * <p> * This class may be useful to implement your own in case you subclass a * type-specific sorted map. */
public static class EmptySortedMap extends Int2ByteMaps.EmptyMap implements Int2ByteSortedMap, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected EmptySortedMap() { } @Override public IntComparator comparator() { return null; } @SuppressWarnings("unchecked") @Override public ObjectSortedSet<Int2ByteMap.Entry> int2ByteEntrySet() { return ObjectSortedSets.EMPTY_SET; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings("unchecked") public ObjectSortedSet<Map.Entry<Integer, Byte>> entrySet() { return ObjectSortedSets.EMPTY_SET; } @Override public IntSortedSet keySet() { return IntSortedSets.EMPTY_SET; } @Override public Int2ByteSortedMap subMap(final int from, final int to) { return EMPTY_MAP; } @Override public Int2ByteSortedMap headMap(final int to) { return EMPTY_MAP; } @Override public Int2ByteSortedMap tailMap(final int from) { return EMPTY_MAP; } @Override public int firstIntKey() { throw new NoSuchElementException(); } @Override public int lastIntKey() { throw new NoSuchElementException(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap headMap(Integer oto) { return headMap((oto).intValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap tailMap(Integer ofrom) { return tailMap((ofrom).intValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap subMap(Integer ofrom, Integer oto) { return subMap((ofrom).intValue(), (oto).intValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer firstKey() { return Integer.valueOf(firstIntKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer lastKey() { return Integer.valueOf(lastIntKey()); } }
An empty sorted map (immutable). It is serializable and cloneable.
/** * An empty sorted map (immutable). It is serializable and cloneable. */
public static final EmptySortedMap EMPTY_MAP = new EmptySortedMap();
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.

/** * An immutable class representing a type-specific singleton sorted map. * * <p> * This class may be useful to implement your own in case you subclass a * type-specific sorted map. */
public static class Singleton extends Int2ByteMaps.Singleton implements Int2ByteSortedMap, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected final IntComparator comparator; protected Singleton(final int key, final byte value, IntComparator comparator) { super(key, value); this.comparator = comparator; } protected Singleton(final int key, final byte 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); } @Override public IntComparator comparator() { return comparator; } @Override public ObjectSortedSet<Int2ByteMap.Entry> int2ByteEntrySet() { if (entries == null) entries = ObjectSortedSets.singleton(new AbstractInt2ByteMap.BasicEntry(key, value), entryComparator(comparator)); return (ObjectSortedSet<Int2ByteMap.Entry>) entries; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings({"rawtypes", "unchecked"}) public ObjectSortedSet<Map.Entry<Integer, Byte>> entrySet() { return (ObjectSortedSet) int2ByteEntrySet(); } @Override public IntSortedSet keySet() { if (keys == null) keys = IntSortedSets.singleton(key, comparator); return (IntSortedSet) keys; } @Override public Int2ByteSortedMap subMap(final int from, final int to) { if (compare(from, key) <= 0 && compare(key, to) < 0) return this; return EMPTY_MAP; } @Override public Int2ByteSortedMap headMap(final int to) { if (compare(key, to) < 0) return this; return EMPTY_MAP; } @Override public Int2ByteSortedMap tailMap(final int from) { if (compare(from, key) <= 0) return this; return EMPTY_MAP; } @Override public int firstIntKey() { return key; } @Override public int lastIntKey() { return key; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap headMap(Integer oto) { return headMap((oto).intValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap tailMap(Integer ofrom) { return tailMap((ofrom).intValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap subMap(Integer ofrom, Integer oto) { return subMap((ofrom).intValue(), (oto).intValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer firstKey() { return Integer.valueOf(firstIntKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override 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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * Returns a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 * {@code &lt;key,value&gt;}. */
public static Int2ByteSortedMap singleton(final Integer key, Byte value) { return new Singleton((key).intValue(), (value).byteValue()); }
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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
  • comparator – the comparator to use in the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * RETURNS a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 * {@code &lt;key,value&gt;}. */
public static Int2ByteSortedMap singleton(final Integer key, Byte value, IntComparator comparator) { return new Singleton((key).intValue(), (value).byteValue(), 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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * Returns a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 * {@code &lt;key,value&gt;}. */
public static Int2ByteSortedMap singleton(final int key, final byte 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.

Params:
  • key – the only key of the returned sorted map.
  • value – the only value of the returned sorted map.
  • comparator – the comparator to use in the returned sorted map.
Returns:a type-specific immutable sorted map containing just the pair &lt;key,value&gt;.
/** * Returns a type-specific immutable sorted map containing only the specified * pair. The returned sorted map is serializable and cloneable. * * <p> * 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 * {@code &lt;key,value&gt;}. */
public static Int2ByteSortedMap singleton(final int key, final byte value, IntComparator comparator) { return new Singleton(key, value, comparator); }
A synchronized wrapper class for sorted maps.
/** A synchronized wrapper class for sorted maps. */
public static class SynchronizedSortedMap extends Int2ByteMaps.SynchronizedMap implements Int2ByteSortedMap, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final Int2ByteSortedMap sortedMap; protected SynchronizedSortedMap(final Int2ByteSortedMap m, final Object sync) { super(m, sync); sortedMap = m; } protected SynchronizedSortedMap(final Int2ByteSortedMap m) { super(m); sortedMap = m; } @Override public IntComparator comparator() { synchronized (sync) { return sortedMap.comparator(); } } @Override public ObjectSortedSet<Int2ByteMap.Entry> int2ByteEntrySet() { if (entries == null) entries = ObjectSortedSets.synchronize(sortedMap.int2ByteEntrySet(), sync); return (ObjectSortedSet<Int2ByteMap.Entry>) entries; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings({"rawtypes", "unchecked"}) public ObjectSortedSet<Map.Entry<Integer, Byte>> entrySet() { return (ObjectSortedSet) int2ByteEntrySet(); } @Override public IntSortedSet keySet() { if (keys == null) keys = IntSortedSets.synchronize(sortedMap.keySet(), sync); return (IntSortedSet) keys; } @Override public Int2ByteSortedMap subMap(final int from, final int to) { return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync); } @Override public Int2ByteSortedMap headMap(final int to) { return new SynchronizedSortedMap(sortedMap.headMap(to), sync); } @Override public Int2ByteSortedMap tailMap(final int from) { return new SynchronizedSortedMap(sortedMap.tailMap(from), sync); } @Override public int firstIntKey() { synchronized (sync) { return sortedMap.firstIntKey(); } } @Override public int lastIntKey() { synchronized (sync) { return sortedMap.lastIntKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer firstKey() { synchronized (sync) { return sortedMap.firstKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer lastKey() { synchronized (sync) { return sortedMap.lastKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap subMap(final Integer from, final Integer to) { return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap headMap(final Integer to) { return new SynchronizedSortedMap(sortedMap.headMap(to), sync); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap 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.
Params:
  • m – the sorted map to be wrapped in a synchronized sorted map.
See Also:
Returns:a synchronized view of the specified sorted map.
/** * 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 Int2ByteSortedMap synchronize(final Int2ByteSortedMap 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.
Params:
  • m – the sorted map to be wrapped in a synchronized sorted map.
  • sync – an object that will be used to synchronize the access to the sorted sorted map.
See Also:
Returns:a synchronized view of the specified sorted map.
/** * 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 Int2ByteSortedMap synchronize(final Int2ByteSortedMap m, final Object sync) { return new SynchronizedSortedMap(m, sync); }
An unmodifiable wrapper class for sorted maps.
/** An unmodifiable wrapper class for sorted maps. */
public static class UnmodifiableSortedMap extends Int2ByteMaps.UnmodifiableMap implements Int2ByteSortedMap, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final Int2ByteSortedMap sortedMap; protected UnmodifiableSortedMap(final Int2ByteSortedMap m) { super(m); sortedMap = m; } @Override public IntComparator comparator() { return sortedMap.comparator(); } @Override public ObjectSortedSet<Int2ByteMap.Entry> int2ByteEntrySet() { if (entries == null) entries = ObjectSortedSets.unmodifiable(sortedMap.int2ByteEntrySet()); return (ObjectSortedSet<Int2ByteMap.Entry>) entries; }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override @SuppressWarnings({"rawtypes", "unchecked"}) public ObjectSortedSet<Map.Entry<Integer, Byte>> entrySet() { return (ObjectSortedSet) int2ByteEntrySet(); } @Override public IntSortedSet keySet() { if (keys == null) keys = IntSortedSets.unmodifiable(sortedMap.keySet()); return (IntSortedSet) keys; } @Override public Int2ByteSortedMap subMap(final int from, final int to) { return new UnmodifiableSortedMap(sortedMap.subMap(from, to)); } @Override public Int2ByteSortedMap headMap(final int to) { return new UnmodifiableSortedMap(sortedMap.headMap(to)); } @Override public Int2ByteSortedMap tailMap(final int from) { return new UnmodifiableSortedMap(sortedMap.tailMap(from)); } @Override public int firstIntKey() { return sortedMap.firstIntKey(); } @Override public int lastIntKey() { return sortedMap.lastIntKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer firstKey() { return sortedMap.firstKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Integer lastKey() { return sortedMap.lastKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap subMap(final Integer from, final Integer to) { return new UnmodifiableSortedMap(sortedMap.subMap(from, to)); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap headMap(final Integer to) { return new UnmodifiableSortedMap(sortedMap.headMap(to)); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Int2ByteSortedMap 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.
Params:
  • m – the sorted map to be wrapped in an unmodifiable sorted map.
See Also:
Returns:an unmodifiable view of the specified sorted map.
/** * 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 Int2ByteSortedMap unmodifiable(final Int2ByteSortedMap m) { return new UnmodifiableSortedMap(m); } }