Module io.github.mmm.base

Package io.github.mmm.base.text

Class CaseHelper

java.lang.Object

io.github.mmm.base.text.CaseHelper

public final class CaseHelper
extends Object

Simple helper for case conversion like toLowerCase(String) or toUpperCase(String). This seems pointless in the first place but prevents typical programming mistakes. Many developers will expect that "HI".toLowerCase() returns "hi". However, this is not always the case! String.toLowerCase() will actually do toLowerCase(Locale.getDefault()). The latter operation is obviously a Locale sensitive operation and can behave differently depending on the given Locale. So e.g. if your Locale is actually Turkish (tr_TR resp. tr-TR) the result of "HI".toLowerCase() will actually be "hı" (notice the missing dot on the i character!). This can lead to serious bugs when creating filenames, URLs or the like via case conversion. Due to such bug nobody with Turkish locale could install Lotus Notes 8.5.1 when it was released.
Simply use this small helper as indirection to the standard String case operations to prevent such mistakes and also to document this fact.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
static String	capitalize(String string)
static String	toLowerCase(String string)	Indirection for String.toLowerCase(Locale) with a standard Locale to prevent accidents.
static String	toLowerCase(String string, Locale locale)	Indirection for String.toLowerCase(Locale).
static String	toUpperCase(String string)	Indirection for String.toUpperCase(Locale) with a standard Locale.US to prevent accidents.
static String	toUpperCase(String string, Locale locale)	Indirection for String.toUpperCase(Locale).
static String	uncapitalize(String string)

Methods inherited from class java.lang.Object

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

Method Details

toLowerCase

public static String toLowerCase(String string)

Indirection for String.toLowerCase(Locale) with a standard Locale to prevent accidents. See CaseHelper type description for details.

Parameters:

string - is the String.

Returns:

the result of String.toLowerCase(Locale).

Since:

4.0.0

toLowerCase

public static String toLowerCase(String string,
 Locale locale)

Indirection for String.toLowerCase(Locale).

Parameters:

string - is the String.

locale - is the Locale.

Returns:

the result of String.toLowerCase(Locale).

toUpperCase

public static String toUpperCase(String string)

Indirection for String.toUpperCase(Locale) with a standard Locale.US to prevent accidents. See CaseHelper type description for details.

Parameters:

string - is the String.

Returns:

the result of String.toUpperCase(Locale).

toUpperCase

public static String toUpperCase(String string,
 Locale locale)

Indirection for String.toUpperCase(Locale).

Parameters:

string - is the String.

locale - is the Locale.

Returns:

the result of String.toUpperCase(Locale).

capitalize

public static String capitalize(String string)

Parameters:

string - is the String. May be null.

Returns:

the capitalized String.

uncapitalize

public static String uncapitalize(String string)

Parameters:

string - is the String. May be null.

Returns:

the capitalized String.