[Java]toString()メソッドの有用な使い方

2018年09月25日

[Java]toString()メソッドの有用な使い方

toString()メソッドとは、java.lang.Objectクラスで定義されている文字列表現を返すメソッドです。

全てのクラスはこのjava.lang.Objectクラスを継承しているため、必然的にどのクラスでもtoString()メソッドが定義されていることになります。

私たちは、無意識のうちにこのtoString()メソッドを使用していることが多々あります。

例えば以下のサンプルコードをご覧下さい。

使用例：

import java.util.HashMap;

public class TestMain{
	public static void main(String[] args){
		HashMap<String, String> map = new HashMap<>();
		map.put("key1", "value1");
		map.put("key2", "value2");
		map.put("key3", "value3");
		System.out.println(map);
	}
}

import java.util.HashMap;

public class TestMain{

public static void main(String[] args){

HashMap<String, String> map = new HashMap<>();

map.put("key1", "value1");

map.put("key2", "value2");

map.put("key3", "value3");

System.out.println(map);

}

出力結果：

{key1=value1, key2=value2, key3=value3}

java.util.HashMapのオブジェクトを生成し、値とキーを３つセットしています。

最後にprintln()メソッドの引数にjava.util.HashMapのオブジェクトを指定して、オブジェクト内の要素を確認するコードになっています。実はjava.lang.String以外の参照型が引数に指定された場合は、そのオブジェクトのtoString()メソッドで文字列が取得され出力されます。

つまり、

System.out.println(map.toString());

と記述しているのと同じ結果になります。

また、出力結果が上記のようになるのは、java.util.HashMapクラスでtoString()メソッドをオーバーライドして、上記の出力になるように文字列を返しているからです。

このようにオブジェクトの内容を文字列化するためのtoString()メソッドは、自作クラスでもオーバーライドすることができます。以下の例をご覧下さい。

使用例：

public class TestBean{
	private int id;
	private String name;
	private String address;
	
	public void setProperties(int id, String name, String address){
		this.id = id;
		this.name = name;
		this.address = address;
	}
	@Override
	public String toString(){
		return "TestBean[id=" + id + ", name=" + name + ", address=" + address + "]";
	}
}

public class TestBean{

private int id;

private String name;

private String address;

public void setProperties(int id, String name, String address){

this.id = id;

this.name = name;

this.address = address;

}

@Override

public String toString(){

return "TestBean[id=" + id + ", name=" + name + ", address=" + address + "]";

}

public class TestMain2{
	public static void main(String[] args){
		TestBean bean = new TestBean();
		bean.setProperties(10, "KEN", "東京都");
		System.out.println(bean);
	}
}