de.goerntkai.toolbox.misc
Class EqualsUtil

java.lang.Object
  extended byde.goerntkai.toolbox.misc.EqualsUtil

public abstract class EqualsUtil
extends java.lang.Object

Collected methods which allow easy implementation of equals. Example use case in a class called Car:

 public boolean equals(Object that) {

     if (this == that) {
         return true;
     }
     if (!(that instanceof Car)) {
         return false;
     }
     Car thatCar = (Car)that;
     return EqualsUtil.areEqual(this.fName, that.fName)
         && EqualsUtil.areEqual(this.fNumDoors, that.fNumDoors)
         && EqualsUtil.areEqual(this.fGasMileage, that.fGasMileage)
         && EqualsUtil.areEqual(this.fColor, that.fColor)
         && Arrays.equals(this.fMaintenanceChecks,
             that.fMaintenanceChecks); //array!
 }
 

Equality of arrays is delegated to the Arrays.equals methods.

Version:
$Id: EqualsUtil.java,v 1.3 2007/04/29 17:54:03 GoerntKai Exp $
Author:
Kai Görnt

Method Summary
static boolean areEqual(boolean[] aThis, boolean[] aThat)
          Compares boolean arrays.
static boolean areEqual(boolean aThis, boolean aThat)
          Compares booleans.
static boolean areEqual(byte[] aThis, byte[] aThat)
          Compares byte arrays.
static boolean areEqual(char[] aThis, char[] aThat)
          Compares character arrays.
static boolean areEqual(char aThis, char aThat)
          Compares characters.
static boolean areEqual(double[] aThis, double[] aThat)
          Compares double arrays.
static boolean areEqual(double aThis, double aThat)
          Compares doubles.
static boolean areEqual(float[] aThis, float[] aThat)
          Compares float arrays.
static boolean areEqual(float aThis, float aThat)
          Compares floats.
static boolean areEqual(int[] aThis, int[] aThat)
          Compares integer arrays.
static boolean areEqual(long[] aThis, long[] aThat)
          Compares long arrays.
static boolean areEqual(long aThis, long aThat)
          Compares longs.
static boolean areEqual(java.lang.Object[] aThis, java.lang.Object[] aThat)
          Compares object arrays.
static boolean areEqual(java.lang.Object aThis, java.lang.Object aThat)
          Compares objects.
static boolean areEqual(short[] aThis, short[] aThat)
          Compares short arrays.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

areEqual

public static boolean areEqual(boolean aThis,
                               boolean aThat)

Compares booleans.

Parameters:
aThis - boolean
aThat - boolean
Returns:
true or false

areEqual

public static boolean areEqual(boolean[] aThis,
                               boolean[] aThat)

Compares boolean arrays.

Parameters:
aThis - boolean array
aThat - boolean array
Returns:
true or false

areEqual

public static boolean areEqual(byte[] aThis,
                               byte[] aThat)

Compares byte arrays.

Parameters:
aThis - byte array
aThat - byte array
Returns:
true or false

areEqual

public static boolean areEqual(char aThis,
                               char aThat)

Compares characters.

Parameters:
aThis - character
aThat - character
Returns:
true or false

areEqual

public static boolean areEqual(char[] aThis,
                               char[] aThat)

Compares character arrays.

Parameters:
aThis - character array
aThat - character array
Returns:
true or false

areEqual

public static boolean areEqual(double aThis,
                               double aThat)

Compares doubles.

Parameters:
aThis - double
aThat - double
Returns:
true or false

areEqual

public static boolean areEqual(double[] aThis,
                               double[] aThat)

Compares double arrays.

Parameters:
aThis - double array
aThat - double array
Returns:
true or false

areEqual

public static boolean areEqual(float aThis,
                               float aThat)

Compares floats.

Parameters:
aThis - float
aThat - float
Returns:
true or false

areEqual

public static boolean areEqual(float[] aThis,
                               float[] aThat)

Compares float arrays.

Parameters:
aThis - float array
aThat - float array
Returns:
true or false

areEqual

public static boolean areEqual(int[] aThis,
                               int[] aThat)

Compares integer arrays.

Parameters:
aThis - integer array
aThat - integer array
Returns:
true or false

areEqual

public static boolean areEqual(long aThis,
                               long aThat)

Compares longs.

Note that byte, short, and int are handled by this method, through implicit conversion.

Parameters:
aThis - long
aThat - long
Returns:
true or false

areEqual

public static boolean areEqual(long[] aThis,
                               long[] aThat)

Compares long arrays.

Parameters:
aThis - long array
aThat - long array
Returns:
true or false

areEqual

public static boolean areEqual(java.lang.Object aThis,
                               java.lang.Object aThat)

Compares objects.

Possibly-null object field. Includes type-safe enumerations and collections, but does not include arrays. See class comment.

Parameters:
aThis - object
aThat - object
Returns:
true or false

areEqual

public static boolean areEqual(java.lang.Object[] aThis,
                               java.lang.Object[] aThat)

Compares object arrays.

Parameters:
aThis - object array
aThat - object array
Returns:
true or false

areEqual

public static boolean areEqual(short[] aThis,
                               short[] aThat)

Compares short arrays.

Parameters:
aThis - short array
aThat - short array
Returns:
true or false


Copyright © 2004-2007 Kai Görnt. All Rights Reserved.