Object に対する処理ルーチンです。
* {@primary Common Object manipulation routines.}
*
* @author Nissim Karpenstein
* @author Janek Bogucki
* @author Daniel Rall
* @author Stephen Colebourne
* @translator 日置 聡
* @status firstdraft
* @update 2003/08/11
* @version $Id: ObjectUtils.java,v 1.1.1.1 2004/02/13 10:02:04 hioki Exp $
*/
public class ObjectUtils {
/**
* null が他の意味を持ってしまう場合の代用のために使用されるシングルトンのインスタンスです。
* {@primary Singleton used as a null placeholder where null has another meaning.}
*
* 例えば、 HashMap の get(key) メソッドは指定されたキーに null
* が関連付けられていた場合にも該当するキーが存在しなかった場合にも null を返します。
* Null は子の2つの場合を区別するために使用されます。
* {@primary For example, in a HashMap the get(key) method returns null
* if the Map contains null or if there is no matching key. The Null
* placeholder can be used to distinguish between these two cases.}
*
* 他の例としては HashTable は null を保持することができません。
* {@primary Another example is HashTable, where null
* cannot be stored.}
*
* このインスタンスは Serializable です。
* {@primary This instance is Serializable.}
*/
public static final Null NULL = new Null();
/**
* ObjectUtils のインスタンスは一般的なプログラムからは生成すべきではありません。
* 代わりに ObjectUtils.defaultIfNull("a","b"); というように使用すべきです。
* このコンストラクタは、処理に JavaBean インスタンスを必要とするツールのために public になっています。
* {@primary ObjectUtils instances should NOT be constructed in standard programming.
* Instead, the class should be used as ObjectUtils.defaultIfNull("a","b");.
* This constructor is public to permit tools that require a JavaBean instance
* to operate.}
*/
public ObjectUtils() {
}
//--------------------------------------------------------------------
/**
* 指定されたオブジェクトが null だった場合に指定されたデフォルト値(オブジェクト)を返します。
* {@primary Returns a default value if the object passed is null.}
*
* @param object チェック対象となるオブジェクト
* {@primary the object to test}
* @param defaultValue デフォルトの値(オブジェクト)
* {@primary the default value to return}
* @return object null だった場合にはデフォルトの値、その他の場合にはチェック対象となるオブジェクト
* {@primary object if it is not null, defaultValue otherwise}
*/
public static Object defaultIfNull(Object object, Object defaultValue) {
return (object != null ? object : defaultValue);
}
/**
* 2つのオブジェクトが等しいかどうかを評価します。
* 片方または両方のオブジェクトが null だった場合にも処理を行うことができます。
* {@primary Compares two objects for equality, where either one or both
* objects may be null.}
*
* @param object1 比較対照となる最初のオブジェクト
* {@primary the first object}
* @param object2 比較対照となる次のオブジェクト
* {@primary the second object}
* @return 2つのオブジェクトの値が等しかった場合、true
* {@primary true if the values of both objects are the same}
*/
public static boolean equals(Object object1, Object object2) {
if (object1 == object2) {
return true;
}
if ((object1 == null) || (object2 == null)) {
return false;
}
return object1.equals(object2);
}
/**
* もしクラスが toString をオーバーライドしていなかった場合に Object が提供する
* toString の結果を返します。null が指定された場合には null を返します。
* {@primary Gets the toString that would be produced by Object if a class did not
* override toString itself. Null will return null.}
*
* @param object toString の結果を表示するオブジェクト、または null
* {@primary the object to create a toString for, may be null}
* @return デフォルトの toString の結果となるテキスト、null が指定された場合には null
* {@primary the default toString text, or null if null passed in}
*/
public static String identityToString(Object object) {
if (object == null) {
return null;
}
return new StringBuffer()
.append(object.getClass().getName())
.append('@')
.append(Integer.toHexString(System.identityHashCode(object)))
.toString();
}
/**
* null が他の意味を持ってしまう場合の代用のために使用されます。
* {@primary Class used as a null placeholder where null has another meaning.}
*
* 例えば、 HashMap の get(key) メソッドは指定されたキーに null
* が関連付けられていた場合にも該当するキーが存在しなかった場合にも null を返します。
* Null は子の2つの場合を区別するために使用されます。
* {@primary For example, in a HashMap the get(key) method returns null
* if the Map contains null or if there is no matching key. The Null
* placeholder can be used to distinguish between these two cases.}
*
* 他の例としては HashTable は null を保持することができません。
* {@primary Another example is HashTable, where null
* cannot be stored.}
*/
public static class Null implements Serializable {
/**
* 制限されたコンストラクタ(シングルトン)
* {@primary Restricted constructor - singleton}
*/
private Null() {
}
/**
* シングルトンを保証します。
* {@primary Ensure singleton.}
* @return シングルトンの値
* {@primary the singleton value}
*/
private Object readResolve() {
return ObjectUtils.NULL;
}
}
}