commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bay...@apache.org
Subject cvs commit: jakarta-commons/beanutils/src/java/org/apache/commons/beanutils BeanComparator.java
Date Tue, 10 Sep 2002 07:01:08 GMT
bayard      2002/09/10 00:01:07

  Added:       beanutils/src/java/org/apache/commons/beanutils
                        BeanComparator.java
  Log:
  Finally :) The BeanComparator submitted by Eric Pugh back in June or sometime.
  With reformatting, removal of (Comparable) casting, renaming of compareProperty
  attribute and modification to constructor.
  
  Revision  Changes    Path
  1.1                  jakarta-commons/beanutils/src/java/org/apache/commons/beanutils/BeanComparator.java
  
  Index: BeanComparator.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons/beanutils/src/java/org/apache/commons/beanutils/BeanComparator.java,v
1.1 2002/09/10 07:01:07 bayard Exp $
   * $Revision: 1.1 $
   * $Date: 2002/09/10 07:01:07 $
   *
   * ====================================================================
   *
   * 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/>.
   *
   */
  
  package org.apache.commons.beanutils;
  
  import java.io.Serializable;
  import java.util.Comparator;
  import org.apache.commons.beanutils.PropertyUtils;
  import org.apache.commons.collections.comparators.ComparableComparator;
  
  /**
   * Allows you to pass the name of a method in and compare two beans
   *
   * @author     <a href"mailto:epugh@upstate.com">Eric Pugh</a>
   * @created    May 5, 2002
   */
  public class BeanComparator implements Comparator, Serializable {
  
      private String property;
      private Comparator comparator;
  
      /**
       * Creates a Bean comparator that calls the property specified 
       * on the objects.
       * If you pass in a null, the BeanComparator defaults to comparing
       * based on the natural order, that is java.lang.Comparable.
       *
       * @param property String name of bean property
       */
      public BeanComparator( String property ) {
          this( property, ComparableComparator.getInstance() );
      }
  
      /**
       * Creates a comparator that compares objects based on the method 
       * name of two JavaBeans.
       *
       * @param property String method name to call to compare 
       * @param comparator      Comparator to call afterwords!
       */
      public BeanComparator( String property, Comparator comparator ) {
          setProperty( property );
          this.comparator = comparator;
      }
  
      /**
       * Sets the method to be called to compare two JavaBeans
       *
       * @param property String method name to call to compare 
       */
      public void setProperty( String property ) {
          this.property = property;
      }
  
  
      /**
       * Gets the property attribute of the BeanComparator
       *
       * @return String method name to call to compare
       */
      public String getProperty() {
          return property;
      }
  
      /**
       * Compare two JavaBeans by their shared property.
       *
       * @param  o1 Object The first bean to get data from to compare against
       * @param  o2 Object The second bean to get data from to compare
       * @return int negative or positive based on order
       */
      public int compare( Object o1, Object o2 ) {
          try {
              Object value1 = PropertyUtils.getProperty( o1, property );
              Object value2 = PropertyUtils.getProperty( o2, property );
              return comparator.compare( value1, value2 );
          }
          catch ( Exception e ) {
              throw new ClassCastException( e.toString() );
          }
      }
  
  }
  
  
  

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


Mime
View raw message