org.apache.commons.lang.builder
クラス EqualsBuilder

java.lang.Object
  拡張org.apache.commons.lang.builder.EqualsBuilder

public class EqualsBuilder
extends Object

Equals を生成する処理です。

Equals generation routines.

このクラスはより良い equals メソッドをクラスに実装するためのメソッドを提供します。 これは Joshua Bloch の Effective Java で説明されているルールに従います。 特に doublefloat、配列の比較のルールはトリッキーです。 また、 equals()hashCode() が首尾一貫しているかどうか確認することは困難です。

This class provides methods to build a good equals method for any class. It follows rules laid out in Effective Java, by Joshua Bloch. In particular the rule for comparing doubles , floats, and arrays can be tricky. Also, making sure that equals() and hashCode() are consistent can be difficult.

等しいと計算される2つのオブジェクトは同じハッシュコードを生成する必要があります。 しかし、 同じハッシュコードを持つ2つのオブジェクトが等しいと計算される必要はありません。

Two object that compare as equals must generate the same hash code. But two objects with the same hash code do not have to be equal.

全ての関連のあるフィールドを比較を行う際の計算に含めるべきです。 取得されたフィールドは無視されるかもしれません(訳注 毎回登録した全てのフィールドを計算するわけではないと言う意味?)。 特にハッシュコードを生成するために使用するフィールドは equals メソッドで使用する必要があり、逆もまた同様です。

All relevant fields should be included in the calculation of equals. Derived fields may be ignored. In particular, any field used in generating a hash code must be used in the equals method, and vice versa.

一般的な使用方法を以下に示します:

Typical use for the code is as follows:
 public boolean equals(Object o) {
   if (!o instanceof MyClass) {
    return false;
   }
  MyClass rhs = (MyClass) o;
  return new EqualsBuilder()
                 .append(field1, rhs.field1)
                 .append(field2, rhs.field2)
                 .append(field3, rhs.field3)
                 .isEquals();
  }
 

もう一つの方法として、リフレクションを使用してフィールドを比較するメソッドがあります。 普通、対象となるフィールドは private であるため、この reflectionEquals メソッドは フィールドのアクセス制限を変更するために Field.setAccessible を使用します。 これは適切なパーミッションが設定されていない限り、セキュリティマネージャが稼動している状態では行うことができません。 また、この方法は明らかに低速です。

Alternatively, there is a method that uses reflection to determine the fields to test. Because these fields are usually private, the method, reflectionEquals, uses Field.setAccessible to change the visibility of the fields. This will fail under a security manager, unless the appropriate permissions are set. It is also slower than testing explicitly.

このメソッドの一般的な使用方法は以下の様になります:

A typical invocation for this method would look like:
 public boolean equals(Object o) {
   return EqualsBuilder.reflectionEquals(this, obj);
 }
 

バージョン:
$Id: EqualsBuilder.java,v 1.1.1.1 2004/02/13 10:02:04 hioki Exp $
作成者:
Steve Downey, Stephen Colebourne
翻訳者:
日置 聡
翻訳状況:
初稿(校正者募集中)
翻訳更新日:
2003/08/18

フィールドの概要
private  boolean isEquals
          テストされたフィールドが等しいかどうか。
 
コンストラクタの概要
EqualsBuilder()
          EqualsBuilder のコンストラクタです。
 
メソッドの概要
 EqualsBuilder append(boolean[] lhs, boolean[] rhs)
          boolean の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(boolean lhs, boolean rhs)
          == を使用して2つの boolean の値が等しいかどうかを評価します。
 EqualsBuilder append(byte[] lhs, byte[] rhs)
          byte の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(byte lhs, byte rhs)
          == を使用して2つの byte の値が等しいかどうかを評価します。
 EqualsBuilder append(char[] lhs, char[] rhs)
          char の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(char lhs, char rhs)
          == を使用して2つの char の値が等しいかどうかを評価します。
 EqualsBuilder append(double[] lhs, double[] rhs)
          double の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(double lhs, double rhs)
          doubleToLong の返すビットのパターンを比較することで2つの double の値が等しいかどうかを評価します。
 EqualsBuilder append(float[] lhs, float[] rhs)
          float の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(float lhs, float rhs)
          doubleToLong の返すビットのパターンを比較することで2つの float の値が等しいかどうかを評価します。
 EqualsBuilder append(int[] lhs, int[] rhs)
          int の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(int lhs, int rhs)
          == を使用して2つの int の値が等しいかどうかを評価します。
 EqualsBuilder append(long[] lhs, long[] rhs)
          long の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(long lhs, long rhs)
          == を使用して2つの long の値が等しいかどうかを評価します。
 EqualsBuilder append(Object[] lhs, Object[] rhs)
          2つのオブジェクトの配列の内容を掘り下げて比較を行います。
 EqualsBuilder append(Object lhs, Object rhs)
          2つの Object が等しいかどうかをそのオブジェクトの equals メソッドを使用して評価します。
 EqualsBuilder append(short[] lhs, short[] rhs)
          short の配列の長さと含まれる全ての値を比較します。
 EqualsBuilder append(short lhs, short rhs)
          == を使用して2つの short の値が等しいかどうかを評価します。
 boolean isEquals()
          評価された全てのフィールドが等しい場合に true を返します。
static boolean reflectionEquals(Object lhs, Object rhs)
          このメソッドは2つのオブジェクトが等しいかどうか判断するためにリフレクションを使用します。
static boolean reflectionEquals(Object lhs, Object rhs, boolean testTransients)
          このメソッドは2つのオブジェクトが等しいかどうか判断するためにリフレクションを使用します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

isEquals

private boolean isEquals
テストされたフィールドが等しいかどうか。
If the fields tested are equals.

コンストラクタの詳細

EqualsBuilder

public EqualsBuilder()
EqualsBuilder のコンストラクタです。 初期状態では(2つの)オブジェクトは等しいとみなされます。
Constructor for EqualsBuilder. Starts off assuming that equals is true.

関連項目:
Object.Object()
メソッドの詳細

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs)
このメソッドは2つのオブジェクトが等しいかどうか判断するためにリフレクションを使用します。
This method uses reflection to determine if the two object are equal.

このメソッドは private フィールドの値を取得するために Field.setAccessible を使用します。 これはセキュリティマネージャが稼動していて、適切なパーミッションが設定されていない場合、 セキュリティ例外が投げられることを意味します。 このメソッドは明らかに非効率です。 transient メンバーは、おそらくフィールドの値から取得されたものでオブジェクトの値とはならないと考え、 処理の対象としません。 static フィールドは処理の対象にはなりません。

It uses Field.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manger, if the permissions are not set up. It is also not as efficient as testing explicitly. Transient members will be not be tested, as they are likely derived fields, and not part of the value of the object. Static fields will not be tested.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
boolean - 評価された2つのオブジェクトが等しいかどうか
boolean - if the two objects have tested equals.

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs,
                                       boolean testTransients)
このメソッドは2つのオブジェクトが等しいかどうか判断するためにリフレクションを使用します。
This method uses reflection to determine if the two object are equal.

このメソッドは private フィールドの値を取得するために Field.setAccessible を使用します。 これはセキュリティマネージャが稼動していて、適切なパーミッションが設定されていない場合、 セキュリティ例外が投げられることを意味します。 このメソッドは明らかに非効率です。 testTransients 引数に true が設定された場合 transient メンバーを処理の対象とし、 false が設定された場合にはフィールドの値から取得されたものでオブジェクトの値とはならないとみなし、 transient メンバーを無視します。 static フィールドは処理の対象にはなりません。

It uses Field.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manger, if the permissions are not set up. It is also not as efficient as testing explicitly. If the TestTransients parameter is set to true, transient members will be tested, otherwise they are ignored, as they are likely derived fields, and not part of the value of the object. Static fields will not be tested.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
testTransients - transient フィールドを含めるかどうか
testTransients whether to include transient fields
戻り値:
boolean - 評価された2つのオブジェクトが等しいかどうか
boolean - if the two objects have tested equals.

append

public EqualsBuilder append(Object lhs,
                            Object rhs)
2つの Object が等しいかどうかをそのオブジェクトの equals メソッドを使用して評価します。
Test if two Objects are equal using their equals method.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(long lhs,
                            long rhs)
== を使用して2つの long の値が等しいかどうかを評価します。
Test if two longs are equal using ==.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(int lhs,
                            int rhs)
== を使用して2つの int の値が等しいかどうかを評価します。
Test if two ints are equal using ==.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(short lhs,
                            short rhs)
== を使用して2つの short の値が等しいかどうかを評価します。
Test if two shorts are equal using ==.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(char lhs,
                            char rhs)
== を使用して2つの char の値が等しいかどうかを評価します。
Test if two chars are equal using ==.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(byte lhs,
                            byte rhs)
== を使用して2つの byte の値が等しいかどうかを評価します。
Test if two bytes are equal using ==.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(double lhs,
                            double rhs)
doubleToLong の返すビットのパターンを比較することで2つの double の値が等しいかどうかを評価します。 これは NaN、無限大、-0.0 をハンドルします。 これは HashCodeBuilder によって生成されたハッシュコードと互換性を持ちます。
Test if two doubles are equal by testing that the pattern of bits returned by doubleToLong are equal. This handles NaNs, Infinties, and -0.0. It is compatible with the hash code generated by HashCodeBuilder.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(float lhs,
                            float rhs)
doubleToLong の返すビットのパターンを比較することで2つの float の値が等しいかどうかを評価します。 これは NaN、無限大、-0.0 をハンドルします。 これは HashCodeBuilder によって生成されたハッシュコードと互換性を持ちます。
Test if two floats are equal by testing that the pattern of bits returned by doubleToLong are equal. This handles NaNs, Infinties, and -0.0. It is compatible with the hash code generated by HashCodeBuilder.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(boolean lhs,
                            boolean rhs)
== を使用して2つの boolean の値が等しいかどうかを評価します。
Test if two booleans are equal using ==.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(Object[] lhs,
                            Object[] rhs)
2つのオブジェクトの配列の内容を掘り下げて比較を行います。 また、このメソッドは多次元配列、不完全な配列(訳注 ragged を無理やり訳しました)、複数の型の配列の比較の際にも呼ばれます。
Performs a deep comparison of two object arrays. This also will be called for the top level of multi-dimensional, ragged, and multi-typed arrays.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(long[] lhs,
                            long[] rhs)
long の配列の長さと含まれる全ての値を比較します。 このメソッドは append(long, long) を利用します。
Deep comparison of array of long Length and all values are compared. The method append(long, long) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(int[] lhs,
                            int[] rhs)
int の配列の長さと含まれる全ての値を比較します。 このメソッドは append(int, int) を利用します。
Deep comparison of array of int Length and all values are compared. The method append(int, int) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(short[] lhs,
                            short[] rhs)
short の配列の長さと含まれる全ての値を比較します。 このメソッドは append(short, short) を利用します。
Deep comparison of array of short Length and all values are compared. The method append(short, short) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(char[] lhs,
                            char[] rhs)
char の配列の長さと含まれる全ての値を比較します。 このメソッドは append(char, char) を利用します。
Deep comparison of array of char Length and all values are compared. The method append(char, char) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(byte[] lhs,
                            byte[] rhs)
byte の配列の長さと含まれる全ての値を比較します。 このメソッドは append(byte, byte) を利用します。
Deep comparison of array of byte Length and all values are compared. The method append(byte, byte) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(double[] lhs,
                            double[] rhs)
double の配列の長さと含まれる全ての値を比較します。 このメソッドは append(double, double) を利用します。
Deep comparison of array of double Length and all values are compared. The method append(double, double) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(float[] lhs,
                            float[] rhs)
float の配列の長さと含まれる全ての値を比較します。 このメソッドは append(float, float) を利用します。
Deep comparison of array of float Length and all values are compared. The method append(float, float) is used.

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

append

public EqualsBuilder append(boolean[] lhs,
                            boolean[] rhs)
boolean の配列の長さと含まれる全ての値を比較します。 このメソッドは append(boolean, boolean) を利用します。

パラメータ:
lhs - 左側
Left Hand Side
rhs - 右側
Right Hand Side
戻り値:
連結してコールするために使用される EqualsBuilder
EqualsBuilder - used to chain calls.

isEquals

public boolean isEquals()
評価された全てのフィールドが等しい場合に true を返します。
Return true if the fields that have been checked are all equal.

戻り値:
boolean


このドキュメントは、Ja-Jakartaにより訳されました。 コメントがある場合は report@jajakarta.orgまでお願いします。
Translated into Japanese by jajakarta.org. The original page is here.
Copyright (c) 2002-2003 - Apache Software Foundation