com.ibm.icu.text

Class CaseMap.Upper

java.lang.Object

com.ibm.icu.text.CaseMap

com.ibm.icu.text.CaseMap.Upper

Enclosing class:

CaseMap

public static final class CaseMap.Upper
extends CaseMap

Uppercasing options and methods. Immutable.

See Also:

CaseMap.toUpper()

Status:

Stable ICU 59.

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.icu.text.CaseMap

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

Field Summary

Fields inherited from class com.ibm.icu.text.CaseMap

internalOptions

Method Summary

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

Methods inherited from class com.ibm.icu.text.CaseMap

fold, toLower, toTitle, toUpper

Methods inherited from class java.lang.Object

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

Method Detail

omitUnchangedText

public CaseMap.Upper 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)

Uppercases 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.toUpperCase(Locale, String)

Status:

Stable ICU 60.

apply

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

Uppercases 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.toUpperCase(Locale, String)

Status:

Stable ICU 59.