Java - java.lang.Object クラス

■ページ目次

java.lang.Object

toString()メソッド
equals()メソッド
hashCode()メソッド

Top

■java.lang.Object

クラス階層のルートです。すべてのクラスは、スーパークラスとして Object クラスを持ちます。
したがって、Objectクラスのメソッドはどのクラスでも使用できます。

おもなメソッド

String toString()
boolean equals(Object obj)
int hashCode()
Object clone()
void finalize()
void notify()
void notifyAll()
void wait()

toString(), equals(), hashCode()メソッドは、オーバーライドして使用するのが普通です。

Top

■toString()メソッド

 String toString()

このオブジェクト(自分自身)を文字列化します。
Objectクラスでは、toString()メソッドの結果は、以下のとおりになります。
```
 getClass().getName() + '@' + Integer.toHexString(hashCode())
```

Top

■商品オブジェクトの文字列化

"AbstractProduct.java"に対して、オブジェクトを文字列化するtoString()メソッドをオーバーライドして作ります。("AbstractProduct.java")
文字列は、以下の形式に従うようにしてください。

 [商品コード, 商品名, 商品定価]


 // 1301
 // package product;
 // 抽象商品クラスです。
 // 商品を扱うクラスが持っていなければならないメソッドを提供しています。
 public abstract class AbstractProduct {
     private String code;    // 商品コード
     private String name;    // 商品名
 
     // 商品オブジェクトを文字列化します。
     public String toString() {                                              
         return "[" + getCode() + ", " + getName() + ", " + getPrice() + "]";
     }                                                                       
 
         :
 
 }

つぎの"TestProduct.java"を作成し、実行してください。


 // 1301 = 1201
 // package application;
 import product.*;
 // 商品クラスをテストするクラスです。
 public class TestProduct {
     public static void main(String[] args) {
         Product p1 = new Product(args[0], args[1], args[2]);
         System.out.println("商品のインスタンスを生成しました。 p1 = " + p1);
         System.out.println("   code = " + p1.getCode());
         System.out.println("   name = " + p1.getName());
         System.out.println("  price = " + p1.getPrice());
     }
 }

□ 実行結果

$ java -classpath classes application.TestProduct A001 パソコン 188000
商品のインスタンスを生成しました。 p1 = [A001, パソコン, 188000]
   code = A001
   name = パソコン
  price = 188000

あわせて"DiscountProduct.java"と"SetProduct.java"にも同様にオブジェクトの文字列かを行うメソッドtoString()をオーバーライドします。


 // 1301
 // package product;
 // 割引商品クラスです。
 // ひとつの商品に対するフィールドやフィールドを操作するためのメソッドを
 // 提供しています。
 public class DiscountProduct extends Product implements DiscountInterface {
     private int discount;      // 商品割引率
 
         :
 
     // 商品オブジェクトを文字列化します。
     public String toString() {                                                                 
         return "[" + getCode() + ", " + getName() + ", " + getPrice() + ", " + getDiscount() + "%]";
     }                                                                                          
 
         :
 
 }


 // 1301
 // package product;
 // セット商品クラスです。
 // ひとつまたは複数の商品を集めて、割引したものをセット商品として扱います。
 // セット商品に対するフィールドやフィールドを操作するためのメソッドを
 // 提供しています。
 public class SetProduct extends AbstractProduct implements DiscountInterface {
     private int discount;                  // セット商品割引率
     private AbstractProduct[] products;    // セット商品リスト
 
         :
 
     // セット商品オブジェクトを文字列化します。
     public String toString() {                                                                     
         return "[" + getCode() + ", " + getName() + ", " + getDiscount() + ", " + getPrice() + "]";
     }                                                                                              
 
         :
 
 }

Top

■equals()メソッド

 boolean equals(Object obj)

このオブジェクト(自分自身)と他のオブジェクト(引数obj)が等しいかどうかを示します。
これは、参照先が同じか否か(すなわち、==)と同じ結果です。これを「浅い比較」といいます。
浅い比較ではなく、equals()メソッドをオーバーライドして使うこともあります。
たとえば、Stringクラスでは、オブジェクトの内容(文字列)を比較して、同じ文字列ならtrueを返すようにしています。（これを「深い比較」といいます）
equals()メソッドの意味する同値関係は以下のとおりです。
- 反射性 (reflexive)
  - 任意の参照値 x について、x.equals(x) は true を返します。
- 対称性 (symmetric)
  - 任意の参照値 x と y について、x.equals(y) は、y.equals(x) が true を返す場合にのみ true を返します。
- 推移性 (transitive)
  - 任意の参照値 x、y、z について、x.equals(y) が true を返し、かつ y.equals(z) が true を返す場合に、x.equals(z) は true を返します。
- 整合性 (consistent)
  - 任意の参照値 x および y について、x.equals(y) を複数呼び出すと常に true を返すか、常に false を返します。(x、y の情報が変更されていない場合)
- nullとの比較
  - null でない任意の参照値 x について、x.equals(null) は false を返します。
equals()メソッドをオーバーライドするときは、あわせてhashCode()メソッドもオーバーライドする必要があります。これは、「等価なオブジェクトは等価なハッシュコードを保持する必要がある」ことを保障するためです。

Top

■hashCode()メソッド

 int hashCode()

このオブジェクト(自分自身)のハッシュコード値を返します。
hashCode()メソッドの一般的な規則は以下のとおりです。
- Java アプリケーションの実行中、同一オブジェクトに対するhashCode() メソッドは同じ整数を一貫して返さなければなりません。ただし、アプリケーションを一度終了してからもう一度同じアプリケーションを実行した場合、このメソッドから返される整数は前回の実行時に返された整数と同じである必要はありません。
- equals() メソッドで 2 つのオブジェクトが等価とされた場合、どちらのオブジェクトで hashCode() メソッドを呼び出しても結果は同じ整数値にならなければなりません。
- equals() メソッドで 2 つのオブジェクトが等価でないとされた場合は、これらのオブジェクトに対して hashCode() メソッドを呼び出したときに、結果が異なる整数値にならなくてもかまいません。しかし、等しくないオブジェクトについては異なる整数値が生成されるようにすれば、ハッシュテーブルのパフォーマンスを上げることができます。

Top

■例

つぎのアプリケーション "HashCode01.java"をコンパイル･実行してください。


 public class HashCode01 {
     public static void main(String[] args) {
         String s1 = new String("Hello");
         String s2 = new String("Hello");
         System.out.println("                      (s1 == s2) = " 
                                                          + (s1 ==  s2));
         System.out.println("                   s1.equals(s2) = " 
                                                          + s1.equals(s2));
         System.out.println("(s1.hashCode() == s2.hashCode()) = "
                                                + (s1.hashCode() == s2.hashCode()));
         System.out.println();
 
         StringBuffer sb1 = new StringBuffer("Hello");
         StringBuffer sb2 = new StringBuffer("Hello");
         System.out.println("                      (sb1 == sb2) = "
                                                          + (sb1 ==  sb2));
         System.out.println("                   sb1.equals(sb2) = "
                                                          + sb1.equals(sb2));
         System.out.println("(sb1.hashCode() == sb2.hashCode()) = "
                                                + (sb1.hashCode() == sb2.hashCode()));
     }
 }

□ 実行結果

$ java HashCode01
                      (s1 == s2) = false
                   s1.equals(s2) = true
(s1.hashCode() == s2.hashCode()) = true

                      (sb1 == sb2) = false
                   sb1.equals(sb2) = false
(sb1.hashCode() == sb2.hashCode()) = false

Top

■商品オブジェクトの同値の定義

equals()メソッド、hashCode()メソッドをオーバーライドして、商品オブジェクトの等価性を保障します。(商品コードが等しいとき等価とします)

"AbstractProduct.java"に対して、オブジェクトの同値性を定義するequals()メソッドとhashCode()メソッドをオーバーライドして作ります。("AbstractProduct.java")


 // 1302
 // package product;
 // 抽象商品クラスです。
 // 商品を扱うクラスが持っていなければならないメソッドを提供しています。
 public abstract class AbstractProduct {
     private String code;    // 商品コード
     private String name;    // 商品名
 
         :
 
     // 商品オブジェクトが等しいか否かを判定します。
     public boolean equals(Object obj) {                
         if (this == obj) {                              
             return true;                               
         }                                              
         if (obj instanceof AbstractProduct) {                   
             return code.equals(((AbstractProduct)obj).getCode());
         }                                              
         return false;                                  
     }                                                  
 
     // 商品オブジェクトのハッシュ･コードを返します。
     public int hashCode() {    
         return code.hashCode();
     }                          
 
         :
 
 }

つぎの"TestProduct.java"を作成し、実行してください。


 // 1302
 // package application;
 // import product.*;
 // 商品クラスをテストするクラスです。
 public class TestProduct {
     public static void main(String[] args) {
         Product p1 = new Product(args[0], args[1], args[2]);
         System.out.println("商品のインスタンスを生成しました。 p1 = " + p1);
         System.out.println("   hash = " + p1.hashCode());
 
         Product p2 = new Product(args[0], args[1], args[2]);
         System.out.println("商品のインスタンスを生成しました。 p2 = " + p2);
         System.out.println("   hash = " + p2.hashCode());
 
         System.out.println();
         System.out.println("   (p1 == p2) = " + (p1 == p2));
         System.out.println("p1.equals(p2) = " + (p1.equals(p2)));
     }
 }

□ 実行結果

$ java -classpath classes application.TestProduct A001 パソコン 188000
商品のインスタンスを生成しました。 p1 = [A001, パソコン, 188000]
   hash = 1984080
商品のインスタンスを生成しました。 p2 = [A001, パソコン, 188000]
   hash = 1984080

   (p1 == p2) = false
p1.equals(p2) = true

Top