| java.lang.Object
 org.apache.commons.beanutils.BeanComparator
| BeanComparator | | public class BeanComparator implements Comparator,Serializable(Code) | |
This comparator compares two beans by the specified bean property.
It is also possible to compare beans based on nested, indexed,
combined, mapped bean properties. Please see the
PropertyUtilsBean
documentation for all property name possibilities.
Note: The BeanComparator passes the values of the specified
bean property to a ComparableComparator, if no comparator is
specified in the constructor. If you are comparing two beans based
on a property that could contain "null" values, a suitable Comparator
or ComparatorChain should be supplied in the constructor.
author:
Eric Pugh
author:
Tim O'Brien |
| Constructor Summary | |
| public | BeanComparator()
Constructs a Bean Comparator without a property set. | | public | BeanComparator(String property)
Constructs a property-based comparator for beans.
This compares two beans by the property
specified in the property parameter. | | public | BeanComparator(String property, Comparator comparator)
Constructs a property-based comparator for beans.
This constructor creates
a BeanComparator that uses the supplied Comparator to compare
the property values. |
| Method Summary | |
| public int | compare(Object o1, Object o2)
Compare two JavaBeans by their shared property. | | public boolean | equals(Object o)
Two BeanComparator's are equals if and only if
the wrapped comparators and the property names to be compared
are equal. | | public Comparator | getComparator()
Gets the Comparator being used to compare beans. | | public String | getProperty()
Gets the property attribute of the BeanComparator
String method name to call to compare. | | public int | hashCode()
Hashcode compatible with equals. | | public void | setProperty(String property)
|
| BeanComparator | | public BeanComparator()(Code) | | Constructs a Bean Comparator without a property set.
Note that this is intended to be used
only in bean-centric environments.
Until
BeanComparator.setProperty is called with a non-null value.
this comparator will compare the Objects only.
|
| BeanComparator | | public BeanComparator(String property)(Code) | | Constructs a property-based comparator for beans.
This compares two beans by the property
specified in the property parameter. This constructor creates
a BeanComparator that uses a ComparableComparator
to compare the property values.
Passing "null" to this constructor will cause the BeanComparator
to compare objects based on natural order, that is
java.lang.Comparable.
Parameters:
property - String Name of a bean property, which may contain the name of a simple, nested, indexed, mapped, or combined property. See PropertyUtilsBean for property query language syntax. If the property passed in is null then the actual objects will be compared |
| BeanComparator | | public BeanComparator(String property, Comparator comparator)(Code) | | Constructs a property-based comparator for beans.
This constructor creates
a BeanComparator that uses the supplied Comparator to compare
the property values.
Parameters:
property - Name of a bean property, can contain the name of a simple, nested, indexed, mapped, or combined property. See PropertyUtilsBean for property query language syntax.
Parameters:
comparator - BeanComparator will pass the values of the specified bean property to this Comparator. If your bean property is not a comparable or contains null values, a suitable comparator may be supplied in this constructor. |
| compare | | public int compare(Object o1, Object o2)(Code) | | Compare two JavaBeans by their shared property.
If
BeanComparator.getProperty is null then the actual objects will be compared.
Parameters:
o1 - Object The first bean to get data from to compare against
Parameters:
o2 - Object The second bean to get data from to compare int negative or positive based on order |
| equals | | public boolean equals(Object o)(Code) | | Two BeanComparator's are equals if and only if
the wrapped comparators and the property names to be compared
are equal.
Parameters:
o - Comparator to compare to whether the the comparators are equal or not |
| getComparator | | public Comparator getComparator()(Code) | | Gets the Comparator being used to compare beans.
the Comparator being used to compare beans |
| getProperty | | public String getProperty()(Code) | | Gets the property attribute of the BeanComparator
String method name to call to compare. A null value indicates that the actual objects will be compared |
| hashCode | | public int hashCode()(Code) | | Hashcode compatible with equals.
the hash code for this comparator |
| setProperty | | public void setProperty(String property)(Code) | | Sets the method to be called to compare two JavaBeans
Parameters:
property - String method name to call to compare If the property passed in is null then the actual objects will be compared |
|
|