Added in API level 29

Summary: Methods | Inherited Methods

CaseMap.Title

Kotlin |Java

public static final class CaseMap.Title
extends CaseMap

java.lang.Object
↳	android.icu.text.CaseMap
	↳	android.icu.text.CaseMap.Title

Titlecasing options and methods. Immutable.

See also:

CaseMap.toTitle()

Summary

Public methods
`CaseMap.Title`	`adjustToCased()` Returns an instance that behaves like this one but adjusts each titlecasing BreakIterator index to the next cased character.
`String`	`apply(Locale locale, BreakIterator iter, CharSequence src)` Titlecases a string.
`<A extends Appendable> A`	`apply(Locale locale, BreakIterator iter, CharSequence src, A dest, Edits edits)` Titlecases a string and optionally records edits (see `omitUnchangedText()`).
`CaseMap.Title`	`noBreakAdjustment()` Returns an instance that behaves like this one but does not adjust the titlecasing BreakIterator indexes; titlecases exactly the characters at breaks from the iterator.
`CaseMap.Title`	`noLowercase()` Returns an instance that behaves like this one but does not lowercase non-initial parts of words when titlecasing.
`CaseMap.Title`	`omitUnchangedText()` Returns an instance that behaves like this one but omits unchanged text when case-mapping with `Edits`.
`CaseMap.Title`	`sentences()` Returns an instance that behaves like this one but titlecases sentences rather than words.
`CaseMap.Title`	`wholeString()` Returns an instance that behaves like this one but titlecases the string as a whole rather than each word.

Inherited methods

From class


        
          android.icu.text.CaseMap

`static CaseMap.Fold`	`fold()`
`abstract CaseMap`	`omitUnchangedText()` Returns an instance that behaves like this one but omits unchanged text when case-mapping with `Edits`.
`static CaseMap.Lower`	`toLower()`
`static CaseMap.Title`	`toTitle()`
`static CaseMap.Upper`	`toUpper()`

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

adjustToCased

Added in API level 29

public CaseMap.Title adjustToCased ()

Returns an instance that behaves like this one but adjusts each titlecasing BreakIterator index to the next cased character. (See the Unicode Standard, chapter 3, Default Case Conversion, R3 toTitlecase(X).)

This used to be the default index adjustment in ICU. Since ICU 60, the default index adjustment is to the next character that is a letter, number, symbol, or private use code point. (Uncased modifier letters are skipped.) The difference in behavior is small for word titlecasing, but the new adjustment is much better for whole-string and sentence titlecasing: It yields "49ers" and "«\u4e30(abc)»" instead of "49Ers" and "«\u4e30(Abc)»".

It is an error to specify multiple titlecasing adjustment options together.

Returns
`CaseMap.Title`	an options object with this option.

See also:

noBreakAdjustment()

apply

Added in API level 29

public String apply (Locale locale, 
                BreakIterator iter, 
                CharSequence src)

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

Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with options bits.)

Parameters
`locale`	`Locale`: The locale ID. Can be null for `Locale#getDefault`. (See `ULocale#toLocale`.)
`iter`	`BreakIterator`: A break iterator to find the first characters of words that are to be titlecased. It is set to the source string (setText()) and used one or more times for iteration (first() and next()). If null, then a word break iterator for the locale is used (or something equivalent).
`src`	`CharSequence`: The original string.

Returns
`String`	the result string.

See also:

UCharacter.toUpperCase(Locale, String)

apply

Added in API level 29

public A apply (Locale locale, 
                BreakIterator iter, 
                CharSequence src, 
                A dest, 
                Edits edits)

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

Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with options bits.)

Parameters
`locale`	`Locale`: The locale ID. Can be null for `Locale#getDefault`. (See `ULocale#toLocale`.)
`iter`	`BreakIterator`: A break iterator to find the first characters of words that are to be titlecased. It is set to the source string (setText()) and used one or more times for iteration (first() and next()). If null, then a word break iterator for the locale is used (or something equivalent).
`src`	`CharSequence`: The original string.
`dest`	`A`: A buffer for the result string. Must not be null.
`edits`	`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
`A`	dest with the result string (or only changes) appended.

See also:

UCharacter.toTitleCase(Locale, String, BreakIterator, int)

noBreakAdjustment

Added in API level 29

public CaseMap.Title noBreakAdjustment ()

Returns an instance that behaves like this one but does not adjust the titlecasing BreakIterator indexes; titlecases exactly the characters at breaks from the iterator.

By default, titlecasing will take each break iterator index, adjust it to the next relevant character (see adjustToCased()), and titlecase that one.

Other characters are lowercased.

Returns
`CaseMap.Title`	an options object with this option.

See also:

UCharacter.TITLECASE_NO_BREAK_ADJUSTMENT

noLowercase

Added in API level 29

public CaseMap.Title noLowercase ()

Returns an instance that behaves like this one but does not lowercase non-initial parts of words when titlecasing.

By default, titlecasing will titlecase the character at each (possibly adjusted) BreakIterator index and lowercase all other characters up to the next iterator index. With this option, the other characters will not be modified.

Returns
`CaseMap.Title`	an options object with this option.

See also:

omitUnchangedText

Added in API level 29

public CaseMap.Title omitUnchangedText ()

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

Returns
`CaseMap.Title`	an options object with this option.

sentences

Added in API level 29

public CaseMap.Title sentences ()

Returns an instance that behaves like this one but titlecases sentences rather than words. (Titlecases only the first character of each sentence, possibly adjusted.)

It is an error to specify multiple titlecasing iterator options together, including both an option and an explicit BreakIterator.

Returns
`CaseMap.Title`	an options object with this option.

See also:

adjustToCased()

wholeString

Added in API level 29

public CaseMap.Title wholeString ()

Returns an instance that behaves like this one but titlecases the string as a whole rather than each word. (Titlecases only the character at index 0, possibly adjusted.)

It is an error to specify multiple titlecasing iterator options together, including both an option and an explicit BreakIterator.

Returns
`CaseMap.Title`	an options object with this option.

See also:

adjustToCased()