Class CaseMap.Lower

java.lang.Object

com.ibm.icu.text.CaseMap

com.ibm.icu.text.CaseMap.Lower

Enclosing class:

CaseMap

public static final class CaseMap.Lower
extends CaseMap

Lowercasing options and methods. Immutable.

See Also:

• CaseMap.toLower()

Status:

Stable ICU 59.

Nested Class Summary

Nested classes/interfaces inherited from class CaseMap

CaseMap.Fold, CaseMap.Lower, CaseMap.Title, CaseMap.Upper

Modifier and Type	Class	Description
static final class	CaseMap.Fold	Case folding options and methods.
static final class	CaseMap.Lower	Lowercasing options and methods.
static final class	CaseMap.Title	Titlecasing options and methods.
static final class	CaseMap.Upper	Uppercasing options and methods.

Field Summary

Fields inherited from class CaseMap

internalOptions

Modifier and Type	Field	Description
protected int	internalOptions	Deprecated. This API is ICU internal only.

Method Summary

Modifier and Type	Method	Description
String	apply(Locale locale, CharSequence src)	Lowercases a string.
<A extends Appendable> A	apply(Locale locale, CharSequence src, A dest, Edits edits)	Lowercases a string and optionally records edits (see omitUnchangedText()).
CaseMap.Lower	omitUnchangedText()	Returns an instance that behaves like this one but omits unchanged text when case-mapping with Edits.

Methods inherited from class CaseMap

fold, toLower, toTitle, toUpper

Modifier and Type	Method	Description
static CaseMap.Fold	fold()
static CaseMap.Lower	toLower()
static CaseMap.Title	toTitle()
static CaseMap.Upper	toUpper()

Methods inherited from class Object

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

Method Details

omitUnchangedText

public CaseMap.Lower omitUnchangedText()

Returns an instance that behaves like this one but omits unchanged text when case-mapping with Edits.

Specified by:

omitUnchangedText in class CaseMap

Returns:

an options object with this option.

Status:

Stable ICU 59.

apply

public String apply(Locale locale,
 CharSequence src)

Lowercases a string. Casing is locale-dependent and context-sensitive. The result may be longer or shorter than the original.

Parameters:

locale - The locale ID. Can be null for Locale.getDefault(). (See ULocale.toLocale().)

src - The original string.

Returns:

the result string.

See Also:

• UCharacter.toLowerCase(Locale, String)

Status:

Stable ICU 60.

apply

public <A extends Appendable> A apply(Locale locale,
 CharSequence src,
 A dest,
 Edits edits)

Lowercases a string and optionally records edits (see omitUnchangedText()). Casing is locale-dependent and context-sensitive. The result may be longer or shorter than the original.

Parameters:

locale - The locale ID. Can be null for Locale.getDefault(). (See ULocale.toLocale().)

src - The original string.

dest - A buffer for the result string. Must not be null.

edits - Records edits for index mapping, working with styled text, and getting only changes (if any). This function calls edits.reset() first. edits can be null.

Returns:

dest with the result string (or only changes) appended.

See Also:

• UCharacter.toLowerCase(Locale, String)

Status:

Stable ICU 59.