commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ep...@apache.org
Subject cvs commit: jakarta-commons/configuration/src/test/org/apache/commons/configuration TestStrictConfigurationComparator.java
Date Sat, 14 Feb 2004 19:10:42 GMT
epugh       2004/02/14 11:10:42

  Added:       configuration/src/java/org/apache/commons/configuration
                        StrictConfigurationComparator.java
                        ConfigurationComparator.java
               configuration/src/test/org/apache/commons/configuration
                        TestStrictConfigurationComparator.java
  Log:
  ConfigurationComparator from Bugzilla bug 16504 from back in january 2003!
  
  Revision  Changes    Path
  1.1                  jakarta-commons/configuration/src/java/org/apache/commons/configuration/StrictConfigurationComparator.java
  
  Index: StrictConfigurationComparator.java
  ===================================================================
  package org.apache.commons.configuration;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2002 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 acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * 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.Iterator;
  
  /**
   * Strict comparator for configurations.
   *
   * @author <a href="mailto:herve.quiroz@esil.univ-mrs.fr">Herve Quiroz</a>
   * @author <a href="mailto:shapira@mpi.com">Yoav Shapira</a>
   */
  public class StrictConfigurationComparator implements ConfigurationComparator
  {
      /**
       * Create a new strict comparator.
       */
      public StrictConfigurationComparator()
      {
      }
  
      /**
       * Compare two configuration objects.
       *
       * @param a the first configuration
       * @param b the second configuration
       * @return true if keys from a are found in b and keys from b are
       *         found in a and for each key in a, the corresponding value
       *         is the sale in for the same key in b
       */
      public boolean compare(Configuration a, Configuration b)
      {
          if ((a == null) && (b == null))
          {
              return true;
          }
          else if (a == null)
          {
              return false;
          }
          else if (b == null)
          {
              return false;
          }
  
          for (Iterator i = a.getKeys(); i.hasNext();)
          {
              String key = (String) i.next();
              Object value = a.getProperty(key);
              if (!value.equals(b.getProperty(key)))
                  return false;
          }
          for (Iterator i = b.getKeys(); i.hasNext();)
          {
              String key = (String) i.next();
              Object value = b.getProperty(key);
              if (!value.equals(a.getProperty(key)))
                  return false;
          }
          return true;
      }
  }
  
  
  
  1.1                  jakarta-commons/configuration/src/java/org/apache/commons/configuration/ConfigurationComparator.java
  
  Index: ConfigurationComparator.java
  ===================================================================
  package org.apache.commons.configuration;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2002 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 acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * 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/>.
   */
  
  /**
   * Comparator for configurations interface.
   *
   * @author <a href="mailto:herve.quiroz@esil.univ-mrs.fr">Herve Quiroz</a>
   */
  public interface ConfigurationComparator
  {
      /**
       * Compare two configuration objects.
       *
       * @param a the first configuration
       * @param b the second configuration
       * @return true if the two configurations are identical according to
       *         the implemented rules
       */
      boolean compare(Configuration a, Configuration b);
  }
  
  
  
  
  1.1                  jakarta-commons/configuration/src/test/org/apache/commons/configuration/TestStrictConfigurationComparator.java
  
  Index: TestStrictConfigurationComparator.java
  ===================================================================
  package org.apache.commons.configuration;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2002 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 acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * 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 junit.framework.TestCase;
  
  /**
   * Tests the StrintConfigurationComparator class
   *
   * @author <a href="mailto:herve.quiroz@esil.univ-mrs.fr">Herve Quiroz</a>
   * @author <a href="shapira@mpi.com">Yoav Shapira</a>
   */
  public class TestStrictConfigurationComparator extends TestCase
  {
      /**
       * The comparator.
       */
      protected StrictConfigurationComparator comparator =
          new StrictConfigurationComparator();
  
      /**
       * The first configuration.
       */
      protected Configuration configuration = new BaseConfiguration();
  
      /**
       * Constructor.
       *
       * @param testName The test name
       */
      public TestStrictConfigurationComparator(String testName)
      {
          super(testName);
      }
  
      /**
       * Tests the comparator.
       */
      public void testCompare()
      {
          // Identity comparison for empty configuration
          assertTrue(
              "Compare an empty configuration with itself",
              comparator.compare(configuration, configuration));
  
          configuration.setProperty("one", "1");
          configuration.setProperty("two", "2");
          configuration.setProperty("three", "3");
  
          // Identify comparison for non-empty configuration
          assertTrue(
              "Compare a configuration with itself",
              comparator.compare(configuration, configuration));
  
          // Create the second configuration
          Configuration other = new BaseConfiguration();
          assertFalse(
              "Compare a configuration with an empty one",
              comparator.compare(configuration, other));
  
          other.setProperty("one", "1");
          other.setProperty("two", "2");
          other.setProperty("three", "3");
  
          // Two identical, non-empty configurations
          assertTrue(
              "Compare a configuration with an identical one",
              comparator.compare(configuration, other));
  
          other.setProperty("four", "4");
          assertFalse(
              "Compare our configuration with another that has an additional key mapping",
              comparator.compare(configuration, other));
  
          configuration.setProperty("four", "4");
          assertTrue(
              "Compare our configuration with another that is identical",
              comparator.compare(configuration, other));
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message