Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> commons >> [ beanutils overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.commons.beanutils
Class BeanComparator  

java.lang.Object
  org.apache.commons.beanutils.BeanComparator

All Implemented Interfaces:

java.util.Comparator, java.io.Serializable

---

public class BeanComparator

extends java.lang.Object

implements java.util.Comparator, java.io.Serializable

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.

---

Field Summary
private  java.util.Comparator	comparator
private  java.lang.String	property

 

Constructor Summary

BeanComparator()           Constructs a Bean Comparator without a property set.

BeanComparator(java.lang.String property)           Constructs a property-based comparator for beans.

BeanComparator(java.lang.String property, java.util.Comparator comparator)           Constructs a property-based comparator for beans.

 

Method Summary
int	compare(java.lang.Object o1, java.lang.Object o2)           Compare two JavaBeans by their shared property.
boolean	equals(java.lang.Object o)           Two BeanComparator's are equals if and only if the wrapped comparators and the property names to be compared are equal.
java.util.Comparator	getComparator()           Gets the Comparator being used to compare beans.
java.lang.String	getProperty()           Gets the property attribute of the BeanComparator
int	hashCode()           Hashcode compatible with equals.
void	setProperty(java.lang.String property)           Sets the method to be called to compare two JavaBeans

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

property

private java.lang.String property

---

comparator

private java.util.Comparator comparator

Constructor Detail

BeanComparator

public BeanComparator()

Constructs a Bean Comparator without a property set.

Note that this is intended to be used only in bean-centric environments.

Until setProperty(java.lang.String) 55 is called with a non-null value. this comparator will compare the Objects only.

---

BeanComparator

public BeanComparator(java.lang.String property)

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.

---

BeanComparator

public BeanComparator(java.lang.String property,
                      java.util.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 Detail

setProperty

public void setProperty(java.lang.String property)

Sets the method to be called to compare two JavaBeans

---

getProperty

public java.lang.String getProperty()

Gets the property attribute of the BeanComparator

---

getComparator

public java.util.Comparator getComparator()

Gets the Comparator being used to compare beans.

---

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

Compare two JavaBeans by their shared property. If getProperty() 55 is null then the actual objects will be compared.

Specified by:

compare in interface java.util.Comparator

---

equals

public boolean equals(java.lang.Object o)

Two BeanComparator's are equals if and only if the wrapped comparators and the property names to be compared are equal.

Specified by:

equals in interface java.util.Comparator

---

hashCode

public int hashCode()

Hashcode compatible with equals.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> commons >> [ beanutils overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---