net.sf.mmm.util.lang.base

Class EqualsCheckerCollection

java.lang.Object

net.sf.mmm.util.lang.api.AbstractEqualsChecker<Object>

net.sf.mmm.util.lang.base.EqualsCheckerCollection

All Implemented Interfaces:

Serializable, EqualsChecker<Object>

public class EqualsCheckerCollection
extends AbstractEqualsChecker<Object>

This is an implementation of EqualsChecker that recursively checks Collections based on a given EqualsChecker delegate. So if two objects should be checked for equality that are both Collections of the same kind, this implementation will check if they have the same length and then recursively check the contained elements. For objects of other types it will delegate to the EqualsChecker given at construction. This way you can simply check if two Collections have the same or equal elements.
In case you want to ignore the type of the collection (e.g. allow List and Set or only different implementations of List with same elements to be considered as equal) you can extend this class and override isEqualCollectionType(Collection, Collection).

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private EqualsChecker<Object>	delegate The delegate to check regular objects.
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
EqualsCheckerCollection(EqualsChecker<Object> delegate) The constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	isEqualCollectionType(Collection<?> collection1, Collection<?> collection2) This method is called from isEqualNotNull(Object, Object) to check if the type of two given Collections should be considered as equal.
protected boolean	isEqualNotNull(Object value1, Object value2) Called from AbstractEqualsChecker.isEqual(Object, Object) if objects are both NOT same and NOT null.

Methods inherited from class net.sf.mmm.util.lang.api.AbstractEqualsChecker

isEqual

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

delegate

private final EqualsChecker<Object> delegate

The delegate to check regular objects.

Constructor Detail

EqualsCheckerCollection

public EqualsCheckerCollection(EqualsChecker<Object> delegate)

The constructor.

Parameters:

delegate - is the EqualsChecker used to check objects other than Collections.

Method Detail

isEqualNotNull

protected boolean isEqualNotNull(Object value1,
                                 Object value2)

Description copied from class: AbstractEqualsChecker

Called from AbstractEqualsChecker.isEqual(Object, Object) if objects are both NOT same and NOT null.

Specified by:

isEqualNotNull in class AbstractEqualsChecker<Object>

Parameters:

value1 - is the first value to check.

value2 - is the first value to check.

Returns:

true if the given values are considered as equal, false otherwise.

isEqualCollectionType

protected boolean isEqualCollectionType(Collection<?> collection1,
                                        Collection<?> collection2)

This method is called from isEqualNotNull(Object, Object) to check if the type of two given Collections should be considered as equal.

Parameters:

collection1 - is the first Collection.

collection2 - is the second Collection.

Returns:

true if the type of the given Collections is considered as equal, false otherwise.