org.josef.util

Class CompareField

java.lang.Object

org.josef.util.CompareField

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",at="2009-09-28") @Review(by="Kees Schotanus",at="2009-10-14",reason="After completing unit tests")
public class CompareField
extends Object

Abstraction of a Field that is used in a comparison to determine the order of Objects that contain this Field.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

See Also:

MultiFieldComparator

Field Summary

Fields

Modifier and Type	Field and Description
static CompareField[]	EMPTY_ARRAY_OF_COMPARE_FIELDS Empty array of Fields.

Constructor Summary

Constructors

Constructor and Description
CompareField(CompareField compareField) Copy constructor.
CompareField(Method... methods) Creates this CompareField that will be orderer ascending.
CompareField(Method method, Order order) Creates this CompareField that will be ordered according to the supplied order.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Determines whether this CompareField is equal to the supplied object.
Method[]	getMethods() Gets a copy of the methods that get the value of this field.
Order	getOrdering() Gets the order of this CompareField.
int	hashCode() Computes the hash code of this CompareField.
void	setOrdering(Order order) Sets the order for this CompareField.
void	toggleOrdering() Toggles the order (ascending/descending) for this CompareField.
String	toString() Creates a String representation of this CompareField.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY_OF_COMPARE_FIELDS

public static final CompareField[] EMPTY_ARRAY_OF_COMPARE_FIELDS

Empty array of Fields.

Constructor Detail

CompareField

public CompareField(CompareField compareField)

Copy constructor.

Parameters:

compareField - The CompareField to copy information from.

Throws:

NullPointerException - When the supplied compareField is null.

CompareField

public CompareField(Method... methods)

Creates this CompareField that will be orderer ascending.

Parameters:

methods - The methods that get the value of this field.

Throws:

NullPointerException - When the supplied methods is null.

CompareField

public CompareField(Method method,
                    Order order)

Creates this CompareField that will be ordered according to the supplied order.

Parameters:

method - The method that gets the value of this field.

order - The order for this CompareField.

Throws:

NullPointerException - When either the supplied method or order is null.

Method Detail

getMethods

public Method[] getMethods()

Gets a copy of the methods that get the value of this field.

Returns:

A copy of the methods that get the value of this field.

getOrdering

public Order getOrdering()

Gets the order of this CompareField.

Returns:

The order of this CompareField.

setOrdering

public void setOrdering(Order order)

Sets the order for this CompareField.

Parameters:

order - The order for this CompareField.

Throws:

NullPointerException - When the supplied order is null.

toggleOrdering

public void toggleOrdering()

Toggles the order (ascending/descending) for this CompareField.

equals

public boolean equals(Object object)

Determines whether this CompareField is equal to the supplied object.
Both objects are equal when all of the following conditions are met:

• The supplied object is of type CompareField
• The methods in both objects are the same
• The ordering in both objects are the same

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

Returns:

True when this CompareField is equal to the supplied object.

hashCode

public int hashCode()

Computes the hash code of this CompareField.

Overrides:

hashCode in class Object

Returns:

Hash code of this CompareField.

toString

public String toString()

Creates a String representation of this CompareField.

Overrides:

toString in class Object

Returns:

A String representation of this CompareField.