Java TreeMapの使い方のサンプル

JavaのTreeMapクラスの使い方のサンプルです。

目次

仕組み  TreeMapクラスとは
  TreeMapクラスとMapインターフェースの関係
並び順を変更する 自然順序のサンプル
  キーの文字の昇順/降順にする
  文字列の長さの昇順/降順にする
取得する 要素を取得(get、for文、forEach)
  要素を検索(containsKeyとcontainsValueの違い)
  中身が空か、要素数を取得(isEmpty/size)
追加・更新 要素を追加・更新(put/replace)
削除 要素を削除(remove/clear)

TreeMapクラスとは

TreeMapクラスの定義

public class TreeMap<K,V>
extends AbstractMap<K,V> // 継承するクラス
implements NavigableMap<K,V>, Cloneable, Serializable // 実装するインターフェース

使用例

Map<String,String> a = new TreeMap<>();

上記はTreeMapクラスをインスタンス化してMapインターフェイス型の変数に代入しています。
この変数aは複数のキーと値を持てるようになります。
<>はジェネリクスです。変数aの中身はStringとStringであると宣言しています。

TreeMapの仕様

項目 説明
TreeMapの
変数のイメージ
TreeMap 1つの変数で複数の「キー」と「値」を保持します。
キーは、任意の文字列を使用できます。
値は、StringやIntegerなどの参照型です。int等の基本型は使用できません。
各項目を要素(element)といいます。
キーの順序 デフォルトは、キーを自然順序で保持します。
文字列は辞書順で数値は昇順です。
Comparatorインターフェースを使って順序のルールを変更することができます。←HashMap、LinkedHashMapと違う点
キーの重複 キーは一意です。重複は許されません。
値の重複は可能です。
スレッドセーフ スレッドセーフではありません。
導入時期 バージョン1.2で導入されました。

以下はOracleのJava8 API仕様のTreeMapクラスのリンクです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/TreeMap.html

TreeMapクラスとMapインターフェースの関係

public class TreeMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, Serializable

TreeMapクラスはMapインターフェースを実装しています。(NavigableMap→SortedMap→Map)

使用例

Map<String,String> a = new TreeMap<>();

TreeMapクラスをインスタンス化する時、TreeMapクラス独自のメソッドを使用しない限り、Mapインターフェイス型の変数に代入することが多いです。
Mapインターフェイスにあるメソッドを使用できます。

以下はOracleのJava8 API仕様のMapインターフェースのリンクです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/Map.html

 

自然順序のサンプル

package test1;

import java.util.TreeMap;
import java.util.Map;

public class Test1 {
    public static void main(String[] args) {

        Map<String,Integer> m1 = new TreeMap<>();
        m1.put("caa", 1);
        m1.put("aa", 1);
        m1.put("b", 1);

        System.out.println(m1); // {aa=1, b=1, caa=1}
        
        Map<String,Integer> m2 = new TreeMap<>();
        m2.put("う", 1);
        m2.put("あ", 1);
        m2.put("い", 1);
        
        System.out.println(m2); // {あ=1, い=1, う=1}
        
        Map<Integer,String> m3 = new TreeMap<>();
        m3.put(2, "aa");
        m3.put(3, "bb");
        m3.put(1, "cc");
        
        System.out.println(m3); // {1=cc, 2=aa, 3=bb}
    }
}

14行目は、登録した順序ではなくキーの自然順序(アルファベット順)になっています。
21行目は、キーの並び順が「あいう」になっています。
28行目は、キーの並び順が「123」になっています。

キーの文字の昇順/降順にする

順序のルールを変更して、キーの文字の降順にするサンプルです。

package test1;

import java.util.Comparator;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {

		//順序のルールを変更。キーの文字の降順にする。
		Map<String, Integer> m = new TreeMap<>(new Comparator<String>() {
			public int compare(String k1, String k2) {
				return k2.compareTo(k1) ;
			}
		});
		m.put("caa", 1);
		m.put("aa", 1);
		m.put("b", 1);

		// キーの文字の降順で表示。c,b,aの並び順。
		System.out.println(m); // {caa=1, b=1, aa=1}
	}
}

11-15行目は匿名クラスです。
Java 匿名クラスのサンプル
11行目のComparatorはインターフェースです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/Comparator.html
13行目は、キーの文字の降順にしています。
16-18行目で値を登録しています。
21行目の結果は、登録した順序ではなくキーの降順(アルファベットの降順)になっています。

上記コードの13行目のreturn k2.compareTo(k1) を
return k1.compareTo(k2)にするとキーの文字の昇順になります。{aa=1, b=1, caa=1}

文字列の長さの昇順/降順にする

順序のルールを変更して、文字列の長さの昇順にするサンプルです。

package test1;

import java.util.Comparator;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {

		//順序のルールを変更。文字列の長さの昇順にする。
		Map<String, Integer> m = new TreeMap<>(new Comparator<String>() {
			public int compare(String k1, String k2) {
				return k1.length() - k2.length() ;
			}
		});
		m.put("caa", 1);
		m.put("aa", 1);
		m.put("b", 1);

		// 文字列の長さの昇順で表示。
		System.out.println(m); // {b=1, aa=1, caa=1}
	}
}

11-15行目は匿名クラスです。
Java 匿名クラスのサンプル
11行目のComparatorはインターフェースです。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/Comparator.html
13行目は、文字列の長さの昇順にしています。
16-18行目で値を登録しています。
21行目の結果は、登録した順序ではなく字列の長さの昇順になっています。

13行目をreturn k2.length() - k1.length()にすると文字列の長さの降順になります。{caa=1, aa=1, b=1}

要素を取得(get、for文、forEach)

public V get(Object key)

getメソッドは、要素のキーを指定して値を取得します。
entrySetメソッドはキーと値を取得します。
keySetメソッドはキーを取得します。
valuesメソッドは値を取得します。

package test1;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {
		Map<String,String> color = new TreeMap<>();
		color.put("a", "赤");
		color.put("b", "黄");
		color.put("c", "青");

		System.out.println(color.get("b")); //黄
		
		for (Map.Entry<String, String> c1 : color.entrySet()) {
			System.out.println(c1.getKey());// a b c
			System.out.println(c1.getValue());// 赤 黄 青
		}
		for (String c1 : color.keySet()) {
			System.out.println(c1);// a b c
		}
		for (String c1 : color.values()) {
			System.out.println(c1);// 赤 黄 青
		}
		color.forEach((a,b) -> System.out.println(a+b));//a赤 b黄 c青
	}
 }

14行目は、entrySetメソッドでキーと値をすべて取得しています。
18行目は、keySetメソッドでキーを取得しています。
21行目は、valuesメソッドで値を取得しています。
24行目は、forEachメソッドでマップの各値を取得しています。変数a以降はラムダ式です。
forEachメソッドは、Java8で導入されました。

要素を検索(containsKeyとcontainsValueの違い)

public boolean containsKey(Object key)
public boolean containsValue(Object value)

containsKeyメソッドは、指定のキーが存在する場合はtrueを、存在しない場合はfalseを返します。 containsValueメソッドは、指定の値が存在する場合はtrueを、存在しない場合はfalseを返します。

package test1;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {
		Map<String,String> color = new TreeMap<>();
		color.put("a", "赤");
		color.put("b", "黄");
		color.put("c", "青");
		
		System.out.println(color.containsKey("b")); // true
		System.out.println(color.containsKey("z")); // false
		System.out.println(color.containsValue("黄")); // true
		System.out.println(color.containsValue("白")); // false
	}
 }

12行目は、containsKeyメソッドで指定のキーがあるか真偽値を取得しています。
14行目は、containsValueメソッドで指定の値があるか真偽値を取得しています。

中身が空か、要素数を取得(isEmpty/size)

public boolean isEmpty()
public int size()

isEmptyメソッドは、中身が空の場合はtrueを、そうでない場合はfalseを返します。
sizeメソッドは、要素数を返します。

package test1;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {
		Map<String,String> color = new TreeMap<>();
		color.put("a", "赤");
		color.put("b", "黄");
		color.put("c", "青");
		
		System.out.println(color.isEmpty());//false
		System.out.println(color.size());//3
		color.clear();
		System.out.println(color.isEmpty());//true
		System.out.println(color.size());//0
	}
 }

13行目は、isEmptyメソッドで中身が空か真偽値を取得しています。
空の場合trueです。

要素を追加・更新(put/replace)

public V put(K key,V value)
public V replace(K key, V value)

putメソッドは要素を追加します。
replaceメソッドはキーを指定して値を置き換えます。

package test1;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {
		Map<String,String> color = new TreeMap<>();

        color.put("a", "赤");
        color.put("b", "黄");
        System.out.println(color);//{a=赤, b=黄}
        color.put("b", "オレンジ");
        System.out.println(color);//{a=赤, b=オレンジ}
        color.replace("b", "シルバー");
        System.out.println(color);//{a=赤, b=シルバー}
	}
 }

9,10行目は、putメソッドで要素を追加しています。
12行目は、既にあるキーを指定しています。上書きされます。
14行目は、replaceメソッドでキーを指定して値を更新しています。

要素を削除(remove/clear)

public V remove(Object key)
public void clear()

removeメソッドは指定の位置の要素を削除します。
clearメソッドはすべての要素を削除します。

package test1;
import java.util.TreeMap;
import java.util.Map;

public class Test1 {
	public static void main(String[] args) {
		Map<String,String> color = new TreeMap<>();
		color.put("a", "赤");
		color.put("b", "黄");
		color.put("c", "青");

		color.remove("a");
		System.out.println(color);//{b=黄, c=青}
		color.clear();
		System.out.println(color);//{}
	}
 }

12行目は、removeメソッドで指定の要素を削除しています。
14行目は、clearメソッドですべての要素を削除しています。

関連の記事

Java HashMapとMapの使い方のサンプル
Java LinkedHashMapの使い方のサンプル

△上に戻る