net.zer0bandwidth.android.lib.util

Class JavaStringComparator

java.lang.Object

net.zer0bandwidth.android.lib.util.StringComparator.Base

net.zer0bandwidth.android.lib.util.JavaStringComparator

All Implemented Interfaces:

java.util.Comparator<java.lang.String>, StringComparator

public class JavaStringComparator
extends StringComparator.Base
implements StringComparator

The most basic implementation of StringComparator, this class is merely a wrapper for the String.compareTo(java.lang.String) method. It exists not only as a trivial example, but also to provide a "standard" comparator for situations in which a reference to a Comparator instance is necessary.

Since:

zer0bandwidth-net/android 0.2.1 (#56)

See Also:

StackOverflow Q#11804733

Nested Class Summary

Nested classes/interfaces inherited from interface net.zer0bandwidth.android.lib.util.StringComparator

StringComparator.Base

Field Summary

Fields inherited from class net.zer0bandwidth.android.lib.util.StringComparator.Base

EVALUATION_INDETERMINATE

Fields inherited from interface net.zer0bandwidth.android.lib.util.StringComparator

EQUAL, S1_IS_GREATER, S2_IS_GREATER

Constructor Summary

Constructors

Constructor and Description
JavaStringComparator() Default constructor.
JavaStringComparator(boolean bForceReturnConstants) Allows the caller to request that the StringComparator.Base.compare(java.lang.String, java.lang.String) method still return the exact values that correspond to the semantic constants available in StringComparator.

Method Summary

Modifier and Type	Method and Description
protected int	executeComparison(java.lang.String s1, java.lang.String s2) Wrapper for String.compareTo(java.lang.String), unless the instance was created with the "force return constants" switch set, in which case the value is coerced to one of the constants from StringComparator.

Methods inherited from class net.zer0bandwidth.android.lib.util.StringComparator.Base

compare, compareAsObjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

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

Constructor Detail

JavaStringComparator

public JavaStringComparator()

Default constructor. Note that the value of StringComparator.Base.compare(java.lang.String, java.lang.String) will be the value that would have been returned by String.compareTo(java.lang.String). If you want to force the comparator to use the semantic constants that are defined in StringComparator, then use the alternative JavaStringComparator(boolean) constructor and pass true.

JavaStringComparator

public JavaStringComparator(boolean bForceReturnConstants)

Allows the caller to request that the StringComparator.Base.compare(java.lang.String, java.lang.String) method still return the exact values that correspond to the semantic constants available in StringComparator.

Parameters:

bForceReturnConstants - if true, then the exact constants from StringComparator will be used; otherwise, the raw return value of String.compareTo(java.lang.String) will be returned.

Method Detail

executeComparison

protected int executeComparison(java.lang.String s1,
                                java.lang.String s2)

Wrapper for String.compareTo(java.lang.String), unless the instance was created with the "force return constants" switch set, in which case the value is coerced to one of the constants from StringComparator.

Specified by:

executeComparison in class StringComparator.Base

Parameters:

s1 - the first string to compare

s2 - the second string to compare

Returns:

the value that String.compareTo(java.lang.String) would have returned, or one of the constants from StringComparator.