Java : SortedMap - API使用例
公開日：2024年01月11日
SortedMap (Java SE 21 & JDK 21) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様書のおともにどうぞ。
概要
そのキーに対して全体順序付けを提供するMapです。 マップの順序付けは、キーの自然順序付けに従って行われるか、ソート・マップ構築時に通常提供されるComparatorを使って行われます。 この順序は、ソート・マップのコレクション・ビュー(entrySet、keySet、valuesメソッドによって返される)の反復処理時に反映されます。
SortedMap インタフェースは、自然順序や Comparator などによってキーが順序づけられた Map です。
final SortedMap<String, Integer> sortedMap = new TreeMap<>();
sortedMap.put("ccc", 10);
sortedMap.put("ddd", 20);
sortedMap.put("aaa", 30);
sortedMap.put("bbb", 40);
// SortedMap : 要素の順番は、キーの自然順序でソートされます。
System.out.println(sortedMap); // {aaa=30, bbb=40, ccc=10, ddd=20}
final var hashMap = new HashMap<String, Integer>();
hashMap.put("ccc", 10);
hashMap.put("ddd", 20);
hashMap.put("aaa", 30);
hashMap.put("bbb", 40);
// HashMap : 要素の順番は保持されません。
System.out.println(hashMap); // {aaa=30, ccc=10, bbb=40, ddd=20}
メソッド
Comparator<? super K> comparator ()
このマップ内のキーを順序付けするのに使うコンパレータを返します。ただし、このマップがそのキーの自然順序付けを使う場合はnullを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // {}
final var comparator = map.comparator();
System.out.println(comparator); // null
final SortedMap<String, Integer> map = new TreeMap<>(Comparator.reverseOrder());
System.out.println(map); // {}
final var comparator = map.comparator();
System.out.println(comparator.equals(Comparator.reverseOrder())); // true
final SortedMap<String, Integer> map = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
System.out.println(map); // {}
final var comparator = map.comparator();
System.out.println(comparator.equals(String.CASE_INSENSITIVE_ORDER)); // true
Set<Map.Entry<K,V>> entrySet ()
このマップに含まれるマッピングのSetビューを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 1);
map.put("b", 2);
map.put("c", 3);
System.out.println(map); // {a=1, b=2, c=3}
final var entries = map.entrySet();
System.out.println(entries); // [a=1, b=2, c=3]
map.replace("b", 20);
System.out.println(map); // {a=1, b=20, c=3}
System.out.println(entries); // [a=1, b=20, c=3]
entries.remove(Map.entry("a", 1));
System.out.println(map); // {b=20, c=3}
System.out.println(entries); // [b=20, c=3]
for (final var entry : entries) {
entry.setValue(entry.getValue() * 10);
}
System.out.println(map); // {b=200, c=30}
System.out.println(entries); // [b=200, c=30]
K firstKey ()
マップ内に現在ある最初(下端)のキーを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // {}
map.put("b", 20);
System.out.println(map); // {b=20}
System.out.println(map.firstKey()); // b
map.put("c", 30);
System.out.println(map); // {b=20, c=30}
System.out.println(map.firstKey()); // b
map.put("a", 10);
System.out.println(map); // {a=10, b=20, c=30}
System.out.println(map.firstKey()); // a
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // {}
try {
map.firstKey();
} catch (NoSuchElementException e) {
System.out.println("NoSuchElementException!");
}
// 結果
// ↓
//NoSuchElementException!
SortedMap<K,V> headMap (K toKey)
このマップのtoKeyよりも確実に小さいキーを持つ部分のビューを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("x", 10);
map.put("y", 20);
map.put("z", 30);
System.out.println(map); // {x=10, y=20, z=30}
final var headMap = map.headMap("z");
System.out.println(headMap); // {x=10, y=20}
map.put("a", 40);
System.out.println(map); // {a=40, x=10, y=20, z=30}
System.out.println(headMap); // {a=40, x=10, y=20}
headMap.remove("x");
System.out.println(map); // {a=40, y=20, z=30}
System.out.println(headMap); // {a=40, y=20}
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 10);
map.put("b", 20);
map.put("c", 30);
System.out.println(map); // {a=10, b=20, c=30}
System.out.println(map.headMap("a")); // {}
System.out.println(map.headMap("b")); // {a=10}
System.out.println(map.headMap("c")); // {a=10, b=20}
System.out.println(map.headMap("d")); // {a=10, b=20, c=30}
Set<K> keySet ()
このマップに含まれるキーのSetビューを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 1);
map.put("b", 2);
map.put("c", 3);
System.out.println(map); // {a=1, b=2, c=3}
final var keys = map.keySet();
System.out.println(keys); // [a, b, c]
map.put("d", 4);
System.out.println(map); // {a=1, b=2, c=3, d=4}
System.out.println(keys); // [a, b, c, d]
keys.remove("a");
System.out.println(map); // {b=2, c=3, d=4}
System.out.println(keys); // [b, c, d]
K lastKey ()
マップ内に現在ある最後(上端)のキーを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // {}
map.put("b", 20);
System.out.println(map); // {b=20}
System.out.println(map.lastKey()); // b
map.put("a", 10);
System.out.println(map); // {a=10, b=20}
System.out.println(map.lastKey()); // b
map.put("c", 30);
System.out.println(map); // {a=10, b=20, c=30}
System.out.println(map.lastKey()); // c
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // {}
try {
map.lastKey();
} catch (NoSuchElementException e) {
System.out.println("NoSuchElementException!");
}
// 結果
// ↓
//NoSuchElementException!
default V putFirst (K k, V v)
UnsupportedOperationExceptionをスローします。
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // []
try {
map.putFirst("a", 10);
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException!");
}
// 結果
// ↓
//UnsupportedOperationException!
default V putLast (K k, V v)
UnsupportedOperationExceptionをスローします。
final SortedMap<String, Integer> map = new TreeMap<>();
System.out.println(map); // []
try {
map.putLast("a", 10);
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException!");
}
// 結果
// ↓
//UnsupportedOperationException!
default SortedMap<K,V> reversed ()
このマップの逆順viewを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 10);
map.put("b", 20);
map.put("c", 30);
System.out.println(map); // {a=10, b=20, c=30}
final var reversedMap = map.reversed();
System.out.println(reversedMap); // {c=30, b=20, a=10}
System.out.println(reversedMap.reversed()); // {a=10, b=20, c=30}
SortedMap<K,V> subMap (K fromKey, K toKey)
このマップのfromKey (これを含む) - toKey (これを含まない)のキー範囲を持つ部分のビューを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("x", 10);
map.put("y", 20);
map.put("z", 30);
System.out.println(map); // {x=10, y=20, z=30}
final var subMap = map.subMap("a", "z");
System.out.println(subMap); // {x=10, y=20}
map.put("a", 40);
System.out.println(map); // {a=40, x=10, y=20, z=30}
System.out.println(subMap); // {a=40, x=10, y=20}
subMap.remove("x");
System.out.println(map); // {a=40, y=20, z=30}
System.out.println(subMap); // {a=40, y=20}
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 10);
map.put("b", 20);
map.put("c", 30);
System.out.println(map); // {a=10, b=20, c=30}
System.out.println(map.subMap("a", "a")); // {}
System.out.println(map.subMap("a", "b")); // {a=10}
System.out.println(map.subMap("a", "c")); // {a=10, b=20}
System.out.println(map.subMap("a", "d")); // {a=10, b=20, c=30}
System.out.println(map.subMap("a", "d")); // {a=10, b=20, c=30}
System.out.println(map.subMap("b", "d")); // {b=20, c=30}
System.out.println(map.subMap("c", "d")); // {c=30}
System.out.println(map.subMap("d", "d")); // {}
SortedMap<K,V> tailMap (K fromKey)
このマップのfromKey以上のキーを持つ部分のビューを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 10);
map.put("b", 20);
map.put("c", 30);
System.out.println(map); // {a=10, b=20, c=30}
final var tailMap = map.tailMap("b");
System.out.println(tailMap); // {b=20, c=30}
map.put("d", 40);
System.out.println(map); // {a=10, b=20, c=30, d=40}
System.out.println(tailMap); // {b=20, c=30, d=40}
tailMap.remove("b");
System.out.println(map); // {a=10, c=30, d=40}
System.out.println(tailMap); // {c=30, d=40}
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 10);
map.put("b", 20);
map.put("c", 30);
System.out.println(map); // {a=10, b=20, c=30}
System.out.println(map.tailMap("a")); // {a=10, b=20, c=30}
System.out.println(map.tailMap("b")); // {b=20, c=30}
System.out.println(map.tailMap("c")); // {c=30}
System.out.println(map.tailMap("d")); // {}
Collection<V> values ()
このマップに含まれる値のCollectionビューを返します。
final SortedMap<String, Integer> map = new TreeMap<>();
map.put("a", 1);
map.put("b", 2);
map.put("c", 3);
System.out.println(map); // {a=1, b=2, c=3}
final var values = map.values();
System.out.println(values); // [1, 2, 3]
map.replace("b", 20);
System.out.println(map); // {a=1, b=20, c=3}
System.out.println(values); // [1, 20, 3]
values.remove(1);
System.out.println(map); // {b=20, c=3}
System.out.println(values); // [20, 3]
try {
values.add(4);
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException!");
}
// 結果
// ↓
//UnsupportedOperationException!
Mapで宣言されたメソッド
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
「Java API 使用例 : Map」をご参照ください。
SequencedMapで宣言されたメソッド
firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues
「Java API 使用例 : SequencedMap」をご参照ください。
関連記事
- API 使用例
- Collection (コレクション)
- Collections (コレクション操作)
- Iterator
- List (リスト)
- Map (マップ)
- Map.Entry (キーと値のペア)
- Queue (キュー)
- AbstractQueue
- ArrayBlockingQueue (ブロッキング・配列キュー)
- ArrayDeque (両端キュー)
- BlockingDeque (ブロッキング・両端キュー)
- BlockingQueue (ブロッキング・キュー)
- ConcurrentLinkedDeque (並列処理用・両端キュー)
- ConcurrentLinkedQueue (並列処理用キュー)
- Deque (両端キュー)
- LinkedBlockingDeque (ブロッキング・リンク両端キュー)
- LinkedBlockingQueue (ブロッキング・リンクキュー)
- LinkedList (二重リンク・リスト)
- PriorityBlockingQueue (ブロッキング・優先度付きキュー)
- PriorityQueue (優先度付きキュー)
- RandomAccess
- Set (セット)
- Spliterator