org.josef.util

Enum CString.StringLengthComparator

java.lang.Object

java.lang.Enum<CString.StringLengthComparator>

org.josef.util.CString.StringLengthComparator

All Implemented Interfaces:

Serializable, Comparable<CString.StringLengthComparator>, Comparator<String>

Enclosing class:

CString

public static enum CString.StringLengthComparator
extends Enum<CString.StringLengthComparator>
implements Comparator<String>

A generic String comparator that compares two Strings based upon their length.
This comparator is based upon Joshua Bloch's Effective Java second edition, item 21. I combined it with advice from Item 3 and added the handling of null values.

Version:

1.0 $Revision: 6488 $

Author:

Joshua Bloch, Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
int	compare(String left, String right) Compares the length of the supplied Strings.
static CString.StringLengthComparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static CString.StringLengthComparator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Enum Constant Detail

INSTANCE

public static final CString.StringLengthComparator INSTANCE

The singleton instance.

Method Detail

values

public static CString.StringLengthComparator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CString.StringLengthComparator c : CString.StringLengthComparator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CString.StringLengthComparator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

compare

public int compare(String left,
                   String right)

Compares the length of the supplied Strings.

Specified by:

compare in interface Comparator<String>

Parameters:

left - The left String to compare.

right - The right String to compare.

Returns:

left.length() - right.length()
Null Strings are considered to be of zero length.