java.util

クラス Objects

java.lang.Object

java.util.Objects

public final class Objects
extends Object

このクラスは、オブジェクトで操作するための static ユーティリティーメソッドで構成されます。このようなユーティリティーには、オブジェクトのハッシュコードを計算したり、オブジェクトを表す文字列を返したり、2 つのオブジェクトを比較したりするために、null セーフまたは null を許容するメソッドが含まれます。

導入されたバージョン:

1.7

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
static <T> int	compare(T a, T b, Comparator<? super T> c) 引数が一致する場合は 0 を返し、それ以外の場合は c.compare(a, b) を返します。
static boolean	deepEquals(Object a, Object b) 引数が相互に深層で等価である場合は true を返し、それ以外の場合は false を返します。
static boolean	equals(Object a, Object b) 引数が相互に等しい場合は true を返し、それ以外の場合は false を返します。
static int	hash(Object... values) 一連の入力値に対してハッシュコードを生成します。
static int	hashCode(Object o) null 以外の引数のハッシュコードを返し、引数が null の場合は 0 を返します。
static <T> T	requireNonNull(T obj) 指定されたオブジェクト参照が null でないことを確認します。
static <T> T	requireNonNull(T obj, String message) 指定されたオブジェクト参照が null でないことを確認し、null の場合はカスタマイズされた NullPointerException をスローします。
static String	toString(Object o) 引数が null でない場合は toString の呼び出し結果を返し、null の場合は "null" を返します。
static String	toString(Object o, String nullDefault) 最初の引数が null でない場合はそれに対する toString の呼び出し結果を返し、それ以外の場合は 2 番目の引数を返します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

equals

public static boolean equals(Object a,
             Object b)

引数が相互に等しい場合は true を返し、それ以外の場合は false を返します。したがって、両方の引数が null の場合は true が返され、1 つの引数だけが null の場合は false が返されます。それ以外の場合は、最初の引数の equals メソッドを使用して等しいかどうかが判定されます。

パラメータ:

a - オブジェクト

b - a と等しいかどうかを比較するオブジェクト

戻り値:

引数が相互に等しい場合は true、それ以外の場合は false

関連項目:

Object.equals(Object)

deepEquals

public static boolean deepEquals(Object a,
                 Object b)

引数が相互に深層で等価である場合は true を返し、それ以外の場合は false を返します。 2 つの null 値は相互に深層で等価です。両方の引数が配列の場合は、Arrays.deepEquals のアルゴリズムを使用して等しいかどうかが判定されます。それ以外の場合は、最初の引数の equals メソッドを使用して等しいかどうかが判定されます。

パラメータ:

a - オブジェクト

b - a と深層で等価であるかどうかを比較するオブジェクト

戻り値:

引数が相互に深層で等価である場合は true、それ以外の場合は false

関連項目:

Arrays.deepEquals(Object[], Object[]), equals(Object, Object)

hashCode

public static int hashCode(Object o)

null 以外の引数のハッシュコードを返し、引数が null の場合は 0 を返します。

パラメータ:

o - オブジェクト

戻り値:

引数が null でない場合はそのハッシュコード、引数が null の場合は 0

関連項目:

Object.hashCode()

hash

public static int hash(Object... values)

一連の入力値に対してハッシュコードを生成します。ハッシュコードの生成は、入力値が配列に格納され、その配列が Arrays.hashCode(Object[]) の呼び出しでハッシュ化されたかのように処理されます。

このメソッドは、複数のフィールドを含むオブジェクトに Object.hashCode() を実装する場合に役立ちます。たとえば、オブジェクトに 3 つのフィールド x、y、z がある場合は、次のように記述できます。

 @Override public int hashCode() {
     return Objects.hash(x, y, z);
 }
 

警告:単一のオブジェクト参照が指定された場合、戻り値はそのオブジェクト参照のハッシュコードと同じではありません。この値は、hashCode(Object) を呼び出すことで計算できます。

パラメータ:

values - ハッシュ化する値

戻り値:

一連の入力値のハッシュ値

関連項目:

Arrays.hashCode(Object[]), List.hashCode()

toString

public static String toString(Object o)

引数が null でない場合は toString の呼び出し結果を返し、null の場合は "null" を返します。

パラメータ:

o - オブジェクト

戻り値:

引数が null でない場合は toString の呼び出し結果、引数が null の場合は "null"

関連項目:

Object.toString(), String.valueOf(Object)

toString

public static String toString(Object o,
              String nullDefault)

最初の引数が null でない場合はそれに対する toString の呼び出し結果を返し、それ以外の場合は 2 番目の引数を返します。

パラメータ:

o - オブジェクト

nullDefault - 最初の引数が null の場合に返す文字列

戻り値:

最初の引数が null でない場合はそれに対する toString の呼び出し結果、それ以外の場合は 2 番目の引数。

関連項目:

toString(Object)

compare

public static <T> int compare(T a,
              T b,
              Comparator<? super T> c)

引数が一致する場合は 0 を返し、それ以外の場合は c.compare(a, b) を返します。したがって、両方の引数が null の場合は 0 が返されます。

引数の 1 つが null のときは、NullPointerException がスローされる場合とそうでない場合があります。これは、Comparator で null 値の順序付けポリシーが選択されていれば、そのポリシーによって決まります。

型パラメータ:

T - 比較されるオブジェクトの型

パラメータ:

a - オブジェクト

b - a と比較されるオブジェクト

c - 最初の 2 つの引数を比較する Comparator

戻り値:

引数が一致する場合は 0、それ以外の場合は c.compare(a, b)。

関連項目:

Comparable, Comparator

requireNonNull

public static <T> T requireNonNull(T obj)

指定されたオブジェクト参照が null でないことを確認します。このメソッドは、次に示すように、メソッドとコンストラクタでパラメータを検証することを主な目的として設計されています。

 public Foo(Bar bar) {
     this.bar = Objects.requireNonNull(bar);
 }
 

型パラメータ:

T - その参照の型

パラメータ:

obj - null かどうかが判定されるオブジェクト参照

戻り値:

obj (null でない場合)

例外:

NullPointerException - obj が null である場合

requireNonNull

public static <T> T requireNonNull(T obj,
                   String message)

指定されたオブジェクト参照が null でないことを確認し、null の場合はカスタマイズされた NullPointerException をスローします。このメソッドは、次に示すように、パラメータが複数のメソッドとコンストラクタでパラメータを検証することを主な目的として設計されています。

 public Foo(Bar bar, Baz baz) {
     this.bar = Objects.requireNonNull(bar, "bar must not be null");
     this.baz = Objects.requireNonNull(baz, "baz must not be null");
 }
 

型パラメータ:

T - その参照の型

パラメータ:

obj - null かどうかが判定されるオブジェクト参照

message - NullPointerException がスローされた場合に使用する詳細メッセージ

戻り値:

obj (null でない場合)

例外:

NullPointerException - obj が null である場合