/*
	* 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.chars;
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.chars.Char2ShortSortedMap.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 Char2ShortSortedMaps { private Char2ShortSortedMaps() { }
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<Character, ?>> entryComparator(final CharComparator comparator) { return (Comparator<Map.Entry<Character, ?>>) (x, y) -> comparator.compare((x.getKey()).charValue(), (y.getKey()).charValue()); }
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<Char2ShortMap.Entry> fastIterator(Char2ShortSortedMap map) { final ObjectSortedSet<Char2ShortMap.Entry> entries = map.char2ShortEntrySet(); return entries instanceof Char2ShortSortedMap.FastSortedEntrySet ? ((Char2ShortSortedMap.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<Char2ShortMap.Entry> fastIterable(Char2ShortSortedMap map) { final ObjectSortedSet<Char2ShortMap.Entry> entries = map.char2ShortEntrySet(); return entries instanceof Char2ShortSortedMap.FastSortedEntrySet ? ((Char2ShortSortedMap.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 Char2ShortMaps.EmptyMap implements Char2ShortSortedMap, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected EmptySortedMap() { } @Override public CharComparator comparator() { return null; } @SuppressWarnings("unchecked") @Override public ObjectSortedSet<Char2ShortMap.Entry> char2ShortEntrySet() { 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<Character, Short>> entrySet() { return ObjectSortedSets.EMPTY_SET; } @Override public CharSortedSet keySet() { return CharSortedSets.EMPTY_SET; } @Override public Char2ShortSortedMap subMap(final char from, final char to) { return EMPTY_MAP; } @Override public Char2ShortSortedMap headMap(final char to) { return EMPTY_MAP; } @Override public Char2ShortSortedMap tailMap(final char from) { return EMPTY_MAP; } @Override public char firstCharKey() { throw new NoSuchElementException(); } @Override public char lastCharKey() { 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 Char2ShortSortedMap headMap(Character oto) { return headMap((oto).charValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Char2ShortSortedMap tailMap(Character ofrom) { return tailMap((ofrom).charValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Char2ShortSortedMap subMap(Character ofrom, Character oto) { return subMap((ofrom).charValue(), (oto).charValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Character firstKey() { return Character.valueOf(firstCharKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Character lastKey() { return Character.valueOf(lastCharKey()); } }
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 Char2ShortMaps.Singleton implements Char2ShortSortedMap, java.io.Serializable, Cloneable { private static final long serialVersionUID = -7046029254386353129L; protected final CharComparator comparator; protected Singleton(final char key, final short value, CharComparator comparator) { super(key, value); this.comparator = comparator; } protected Singleton(final char key, final short value) { this(key, value, null); } final int compare(final char k1, final char k2) { return comparator == null ? (Character.compare((k1), (k2))) : comparator.compare(k1, k2); } @Override public CharComparator comparator() { return comparator; } @Override public ObjectSortedSet<Char2ShortMap.Entry> char2ShortEntrySet() { if (entries == null) entries = ObjectSortedSets.singleton(new AbstractChar2ShortMap.BasicEntry(key, value), entryComparator(comparator)); return (ObjectSortedSet<Char2ShortMap.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<Character, Short>> entrySet() { return (ObjectSortedSet) char2ShortEntrySet(); } @Override public CharSortedSet keySet() { if (keys == null) keys = CharSortedSets.singleton(key, comparator); return (CharSortedSet) keys; } @Override public Char2ShortSortedMap subMap(final char from, final char to) { if (compare(from, key) <= 0 && compare(key, to) < 0) return this; return EMPTY_MAP; } @Override public Char2ShortSortedMap headMap(final char to) { if (compare(key, to) < 0) return this; return EMPTY_MAP; } @Override public Char2ShortSortedMap tailMap(final char from) { if (compare(from, key) <= 0) return this; return EMPTY_MAP; } @Override public char firstCharKey() { return key; } @Override public char lastCharKey() { 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 Char2ShortSortedMap headMap(Character oto) { return headMap((oto).charValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Char2ShortSortedMap tailMap(Character ofrom) { return tailMap((ofrom).charValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Char2ShortSortedMap subMap(Character ofrom, Character oto) { return subMap((ofrom).charValue(), (oto).charValue()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Character firstKey() { return Character.valueOf(firstCharKey()); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Character lastKey() { return Character.valueOf(lastCharKey()); } }
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 Char2ShortSortedMap singleton(final Character key, Short value) { return new Singleton((key).charValue(), (value).shortValue()); }
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 Char2ShortSortedMap singleton(final Character key, Short value, CharComparator comparator) { return new Singleton((key).charValue(), (value).shortValue(), 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 Char2ShortSortedMap singleton(final char key, final short 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 Char2ShortSortedMap singleton(final char key, final short value, CharComparator 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 Char2ShortMaps.SynchronizedMap implements Char2ShortSortedMap, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final Char2ShortSortedMap sortedMap; protected SynchronizedSortedMap(final Char2ShortSortedMap m, final Object sync) { super(m, sync); sortedMap = m; } protected SynchronizedSortedMap(final Char2ShortSortedMap m) { super(m); sortedMap = m; } @Override public CharComparator comparator() { synchronized (sync) { return sortedMap.comparator(); } } @Override public ObjectSortedSet<Char2ShortMap.Entry> char2ShortEntrySet() { if (entries == null) entries = ObjectSortedSets.synchronize(sortedMap.char2ShortEntrySet(), sync); return (ObjectSortedSet<Char2ShortMap.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<Character, Short>> entrySet() { return (ObjectSortedSet) char2ShortEntrySet(); } @Override public CharSortedSet keySet() { if (keys == null) keys = CharSortedSets.synchronize(sortedMap.keySet(), sync); return (CharSortedSet) keys; } @Override public Char2ShortSortedMap subMap(final char from, final char to) { return new SynchronizedSortedMap(sortedMap.subMap(from, to), sync); } @Override public Char2ShortSortedMap headMap(final char to) { return new SynchronizedSortedMap(sortedMap.headMap(to), sync); } @Override public Char2ShortSortedMap tailMap(final char from) { return new SynchronizedSortedMap(sortedMap.tailMap(from), sync); } @Override public char firstCharKey() { synchronized (sync) { return sortedMap.firstCharKey(); } } @Override public char lastCharKey() { synchronized (sync) { return sortedMap.lastCharKey(); } }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Character 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 Character 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 Char2ShortSortedMap subMap(final Character from, final Character 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 Char2ShortSortedMap headMap(final Character 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 Char2ShortSortedMap tailMap(final Character 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 Char2ShortSortedMap synchronize(final Char2ShortSortedMap 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 Char2ShortSortedMap synchronize(final Char2ShortSortedMap 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 Char2ShortMaps.UnmodifiableMap implements Char2ShortSortedMap, java.io.Serializable { private static final long serialVersionUID = -7046029254386353129L; protected final Char2ShortSortedMap sortedMap; protected UnmodifiableSortedMap(final Char2ShortSortedMap m) { super(m); sortedMap = m; } @Override public CharComparator comparator() { return sortedMap.comparator(); } @Override public ObjectSortedSet<Char2ShortMap.Entry> char2ShortEntrySet() { if (entries == null) entries = ObjectSortedSets.unmodifiable(sortedMap.char2ShortEntrySet()); return (ObjectSortedSet<Char2ShortMap.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<Character, Short>> entrySet() { return (ObjectSortedSet) char2ShortEntrySet(); } @Override public CharSortedSet keySet() { if (keys == null) keys = CharSortedSets.unmodifiable(sortedMap.keySet()); return (CharSortedSet) keys; } @Override public Char2ShortSortedMap subMap(final char from, final char to) { return new UnmodifiableSortedMap(sortedMap.subMap(from, to)); } @Override public Char2ShortSortedMap headMap(final char to) { return new UnmodifiableSortedMap(sortedMap.headMap(to)); } @Override public Char2ShortSortedMap tailMap(final char from) { return new UnmodifiableSortedMap(sortedMap.tailMap(from)); } @Override public char firstCharKey() { return sortedMap.firstCharKey(); } @Override public char lastCharKey() { return sortedMap.lastCharKey(); }
{@inheritDoc}
Deprecated:Please use the corresponding type-specific method instead.
/** * {@inheritDoc} * * @deprecated Please use the corresponding type-specific method instead. */
@Deprecated @Override public Character 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 Character 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 Char2ShortSortedMap subMap(final Character from, final Character 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 Char2ShortSortedMap headMap(final Character 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 Char2ShortSortedMap tailMap(final Character 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 Char2ShortSortedMap unmodifiable(final Char2ShortSortedMap m) { return new UnmodifiableSortedMap(m); } }