com.atlassian.jira.util

Enum NaturalOrderStringComparator

java.lang.Object

java.lang.Enum<NaturalOrderStringComparator>

com.atlassian.jira.util.NaturalOrderStringComparator

All Implemented Interfaces:

Serializable, Comparable<NaturalOrderStringComparator>, Comparator<String>

public enum NaturalOrderStringComparator
extends Enum<NaturalOrderStringComparator>
implements Comparator<String>

Natural Order String Comparator compares Strings in a more "human friendly" way. For instance, in a natural order String comparator, "z9.txt" comes before "z10.txt". The whitespaces are also stripped so that "z9.txt" will come before "z 10.txt". The comparator is not locale-dependent.

Since:

v5.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CASE_INSENSITIVE_ORDER
CASE_SENSITIVE_ORDER

Method Summary

Modifier and Type	Method and Description
int	compare(String str1, String str2)
static NaturalOrderStringComparator	valueOf(String name) Returns the enum constant of this type with the specified name.
static NaturalOrderStringComparator[]	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

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

CASE_SENSITIVE_ORDER

public static final NaturalOrderStringComparator CASE_SENSITIVE_ORDER

CASE_INSENSITIVE_ORDER

public static final NaturalOrderStringComparator CASE_INSENSITIVE_ORDER

Method Detail

values

public static NaturalOrderStringComparator[] 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 (NaturalOrderStringComparator c : NaturalOrderStringComparator.values())
    System.out.println(c);

Returns:

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

valueOf

public static NaturalOrderStringComparator 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 str1,
                   String str2)

Specified by:

compare in interface Comparator<String>