stephenh    2002/07/25 00:28:16

  Modified:    src/java/org/apache/torque/om NumberKey.java
  Added:       src/test/org/apache/torque/om NumberKeyTest.java
  Log:
  Fixed equals/hashCode/compareTo contracts as brought up by Runako Godfrey 
([EMAIL PROTECTED]).
  
  Revision  Changes    Path
  1.1                  
jakarta-turbine-torque/src/test/org/apache/torque/om/NumberKeyTest.java
  
  Index: NumberKeyTest.java
  ===================================================================
  package org.apache.torque.om;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *    "Apache Turbine" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache",
   *    "Apache Turbine", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import java.util.Arrays;
  
  import junit.framework.Assert;
  import junit.framework.TestCase;
  
  /**
   * Currently just tests the equality of NumberKey.
   * 
   * @author <a href="mailto:[EMAIL PROTECTED]";>Stephen Haberman</a>
   * @version $Revision: 1.1 $
   */
  public class NumberKeyTest extends TestCase
  {
      
      private NumberKey n1a = new NumberKey(1);
      private NumberKey n1b = new NumberKey(1);
      private NumberKey n1c = new NumberKey(1);
      private NumberKey n2a = new NumberKey(2);
      
      /**
       * Simple constructor.
       * 
       * @param name the name of the test to execute
       */
      public NumberKeyTest(String name)
      {
          super(name);
      }
      
      public void testReflexive()
      {
          Assert.assertTrue(n1a.equals(n1a));
      }
      
      public void testSymmetric()
      {
          Assert.assertTrue(n1a.equals(n1b));
          Assert.assertTrue(n1b.equals(n1a));
          
          Assert.assertTrue(!"1".equals(n1a));
          Assert.assertTrue(!n1a.equals("1"));
          
          Assert.assertTrue(!n1a.equals(new Integer(1)));
          Assert.assertTrue(!new Integer(1).equals(n1a));
      }
      
      public void testTransitive()
      {
          Assert.assertTrue(n1a.equals(n1b));
          Assert.assertTrue(n1b.equals(n1c));
          Assert.assertTrue(n1c.equals(n1a));
      }
      
      public void testNull()
      {
          Assert.assertTrue(!n1a.equals(null));
      }
      
      public void testList()
      {
          Object[] array = new Object[] { n1a, n2a, n1b };
          Arrays.sort(array);
  
          Assert.assertEquals(n1a, array[0]);
          Assert.assertEquals(n1b, array[1]);
          Assert.assertEquals(n2a, array[2]);
      }
      
  }
  
  
  1.6       +49 -19    
jakarta-turbine-torque/src/java/org/apache/torque/om/NumberKey.java
  
  Index: NumberKey.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/om/NumberKey.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- NumberKey.java    30 Apr 2002 09:22:38 -0000      1.5
  +++ NumberKey.java    25 Jul 2002 07:28:16 -0000      1.6
  @@ -151,29 +151,59 @@
       }
   
       /**
  -     * keyObj is equal to this NumberKey if keyObj is a NumberKey or String
  -     * that contains the same information this key contains.  Two ObjectKeys
  -     * that both contain null values are not considered equal.
  +     * Two ObjectKeys that both contain null values <strong>are not</strong> 
considered equal.
  +     * 
  +     * @param keyObj the key to compare values to
  +     * @return whether the two objects are equal
        */
       public boolean equals(Object keyObj)
       {
  -        boolean isEqual = false;
  -
  -        if ( key != null )
  -        {
  -            if (keyObj instanceof String)
  -            {
  -                isEqual =  toString().equals(keyObj);
  -            }
  -            // check against a NumberKey. Two keys are equal, if their
  -            // internal keys equivalent.
  -            else if (keyObj instanceof NumberKey)
  -            {
  -                Object obj = ((NumberKey) keyObj).getValue();
  -                isEqual =  key.equals(obj);
  -            }
  +        if (keyObj == this)
  +        {
  +            return true;
  +        }
  +        
  +        if (!(keyObj instanceof NumberKey))
  +        {
  +            return false;
  +        }
  +        
  +        if (getValue() != null)
  +        {
  +            return getValue().equals(((NumberKey) keyObj).getValue());
  +        }
  +        else if (((NumberKey) keyObj).getValue() != null)
  +        {
  +            return false;
  +        }
  +        else
  +        {
  +            // They are both null...still return false.
  +            return false;
  +        }
  +    }
  +   
  +    /**
  +     * @return a hash code based on the value
  +     */ 
  +    public int hashCode()
  +    {
  +        if (getValue() == null)
  +        {
  +            super.hashCode();
           }
  -        return isEqual;
  +        else
  +        {
  +            return getValue().hashCode();
  +        }
  +    }
  +    
  +    /**
  +     * @return a numeric comparison of the two values
  +     */
  +    public int compareTo(Object o)
  +    {
  +        return getBigDecimal().compareTo(((NumberKey) o).getBigDecimal());
       }
   
       /**
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to