Class CaseMap.Fold

  • Enclosing class:
    CaseMap

    public static final class CaseMap.Fold
    extends CaseMap
    Case folding options and methods. Immutable.
    See Also:
    CaseMap.fold()
    • Method Detail

      • 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.
      • 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
      • apply

        public java.lang.String apply​(java.lang.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)
      • apply

        public <A extends java.lang.Appendable> A apply​(java.lang.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)