Class CaseMap.Fold

java.lang.Object

com.ibm.icu.text.CaseMap

com.ibm.icu.text.CaseMap.Fold

Enclosing class:

CaseMap

public static final class CaseMap.Fold
extends CaseMap

Case folding options and methods. Immutable.

See Also:

• CaseMap.fold()

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(CharSequence src)	Case-folds a string.
<A extends Appendable> A	apply(CharSequence src, A dest, Edits edits)	Case-folds a string and optionally records edits (see omitUnchangedText()).
CaseMap.Fold	omitUnchangedText()	Returns an instance that behaves like this one but omits unchanged text when case-mapping with Edits.
CaseMap.Fold	turkic()	Returns an instance that behaves like this one but handles dotted I and dotless i appropriately for Turkic languages (tr, az).

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.Fold 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.

turkic

public CaseMap.Fold turkic()

Returns an instance that behaves like this one but handles dotted I and dotless i appropriately for Turkic languages (tr, az).

Uses the Unicode CaseFolding.txt mappings marked with 'T' that are to be excluded for default mappings and included for the Turkic-specific mappings.

Returns:

an options object with this option.

See Also:

• UCharacter.FOLD_CASE_EXCLUDE_SPECIAL_I

Status:

Stable ICU 59.

apply

public String apply(CharSequence src)

Case-folds a string. The result may be longer or shorter than the original.

Case-folding is locale-independent and not context-sensitive, but there is an option for whether to include or exclude mappings for dotted I and dotless i that are marked with 'T' in CaseFolding.txt.

Parameters:

src - The original string.

Returns:

the result string.

See Also:

• UCharacter.foldCase(String, int)

Status:

Stable ICU 60.

apply

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

Case-folds a string and optionally records edits (see omitUnchangedText()). The result may be longer or shorter than the original.

Case-folding is locale-independent and not context-sensitive, but there is an option for whether to include or exclude mappings for dotted I and dotless i that are marked with 'T' in CaseFolding.txt.

Parameters:

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.foldCase(String, int)

Status:

Stable ICU 59.