Edits Class

Definition

[Android.Runtime.Register("android/icu/text/Edits", ApiSince=29, DoNotGenerateAcw=true)]
public sealed class Edits : Java.Lang.Object

[<Android.Runtime.Register("android/icu/text/Edits", ApiSince=29, DoNotGenerateAcw=true)>]
type Edits = class
    inherit Object

Inheritance

Object

JavaObject

Object

Edits

Attributes

RegisterAttribute

Remarks

Records lengths of string edits but not replacement text. Supports replacements, insertions, deletions in linear progression. Does not support moving/reordering of text.

There are two types of edits: <em>change edits</em> and <em>no-change edits</em>. Add edits to instances of this class using #addReplace(int, int) (for change edits) and #addUnchanged(int) (for no-change edits). Change edits are retained with full granularity, whereas adjacent no-change edits are always merged together. In no-change edits, there is a one-to-one mapping between code points in the source and destination strings.

After all edits have been added, instances of this class should be considered immutable, and an Edits.Iterator can be used for queries.

There are four flavors of Edits.Iterator: <ul> <li>#getFineIterator() retains full granularity of change edits. <li>#getFineChangesIterator() retains full granularity of change edits, and when calling next() on the iterator, skips over no-change edits (unchanged regions). <li>#getCoarseIterator() treats adjacent change edits as a single edit. (Adjacent no-change edits are automatically merged during the construction phase.) <li>#getCoarseChangesIterator() treats adjacent change edits as a single edit, and when calling next() on the iterator, skips over no-change edits (unchanged regions). </ul>

For example, consider the string "abcßDeF", which case-folds to "abcssdef". This string has the following fine edits: <ul> <li>abc ⇨ abc (no-change) <li>ß ⇨ ss (change) <li>D ⇨ d (change) <li>e ⇨ e (no-change) <li>F ⇨ f (change) </ul> and the following coarse edits (note how adjacent change edits get merged together): <ul> <li>abc ⇨ abc (no-change) <li>ßD ⇨ ssd (change) <li>e ⇨ e (no-change) <li>F ⇨ f (change) </ul>

The "fine changes" and "coarse changes" iterators will step through only the change edits when their Edits.Iterator#next() methods are called. They are identical to the non-change iterators when their Edits.Iterator#findSourceIndex(int) or Edits.Iterator#findDestinationIndex(int) methods are used to walk through the string.

For examples of how to use this class, see the test TestCaseMapEditsIteratorDocs in UCharacterCaseTest.java.

Java documentation for android.icu.text.Edits.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.