org.josef.util

Class CodeDescription

java.lang.Object

org.josef.util.CodeDescription

All Implemented Interfaces:

Serializable, Comparable<CodeDescription>

@Status(stage=PRODUCTION,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @Wishes(value=@Wish(value="Make this class type safe!"))
public final class CodeDescription
extends Object
implements Serializable, Comparable<CodeDescription>

Abstraction of an immutable code and description pair.
A collection of these code and description pairs could be used to fill a select list for example.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<CodeDescription>	caseInsensitiveDescriptionComparator A comparator that sorts on description (case insensitive and ascending) and then code ascending.
static CodeDescription[]	EMPTY_ARRAY_OF_CODE_DESCRIPTIONS Empty array of CodeDescriptions.

Constructor Summary

Constructors

Constructor and Description
CodeDescription(Serializable code, String description) Constructs a code and description pair from the supplied code and description.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CodeDescription codeDescription) Compares this CodeDescription to the supplied codeDescription.
static MultiFieldComparator<CodeDescription>	createCodeComparator() Creates a comparator that sorts on code ascending and then description ascending.
static MultiFieldComparator<CodeDescription>	createDescriptionComparator() Creates a comparator that sorts on description ascending and then code ascending.
boolean	equals(Object object) Determines whether this CodeDescription and the supplied object are the same.
Serializable	getCode() Gets the code.
String	getDescription() Gets the description.
int	hashCode() Computes a hash code for this CodeDescription.
String	toString() Creates a String representation of this code description pair.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY_OF_CODE_DESCRIPTIONS

public static final CodeDescription[] EMPTY_ARRAY_OF_CODE_DESCRIPTIONS

Empty array of CodeDescriptions.

caseInsensitiveDescriptionComparator

public static final Comparator<CodeDescription> caseInsensitiveDescriptionComparator

A comparator that sorts on description (case insensitive and ascending) and then code ascending.

Constructor Detail

CodeDescription

public CodeDescription(Serializable code,
                       String description)

Constructs a code and description pair from the supplied code and description.

Parameters:

code - The code.

description - The description.

Throws:

NullPointerException - When the supplied description is null.

Method Detail

getCode

public Serializable getCode()

Gets the code.

Returns:

The code.

getDescription

public String getDescription()

Gets the description.

Returns:

The description.

compareTo

public int compareTo(CodeDescription codeDescription)

Compares this CodeDescription to the supplied codeDescription.
Order is done on description first and code second.

Specified by:

compareTo in interface Comparable<CodeDescription>

Parameters:

codeDescription - The CodeDescription to compare to this CodeDescription.

Returns:

-1 when this > codeDescription, 0 when this == codeDescription and 1 when this > codeDescription.

Throws:

NullPointerException - When the supplied codeDescription is null.

equals

public boolean equals(Object object)

Determines whether this CodeDescription and the supplied object are the same.
The two objects are the same if the supplied object is not null and is a CodeDescription and the code/description in both objects are the same.

Overrides:

equals in class Object

Parameters:

object - The CodeDescription to test for equality.

Returns:

True if both objects are the same, false otherwise.

hashCode

public int hashCode()

Computes a hash code for this CodeDescription.

Overrides:

hashCode in class Object

Returns:

A hash code value for this CodeDescription.

createCodeComparator

public static MultiFieldComparator<CodeDescription> createCodeComparator()

Creates a comparator that sorts on code ascending and then description ascending.

Returns:

A comparator that sorts on code ascending and then description ascending.

createDescriptionComparator

public static MultiFieldComparator<CodeDescription> createDescriptionComparator()

Creates a comparator that sorts on description ascending and then code ascending.

Returns:

A comparator that sorts on description ascending and then code ascending.

toString

public String toString()

Creates a String representation of this code description pair.
Since this method could be used from within a Swing component it simply returns the description.

Overrides:

toString in class Object

Returns:

Description of this code description pair.