Package libcore.icu

Class AlphabeticIndex

java.lang.Object
libcore.icu.AlphabeticIndex
public final class AlphabeticIndex
extends Object
Exposes icu4c's AlphabeticIndex.

  • Constructor Details

    • AlphabeticIndex

      public AlphabeticIndex​(Locale locale)
      Creates a new AlphabeticIndex for the given locale.

  • Method Details

    • finalize

      protected void finalize() throws Throwable
      Description copied from class: Object
      Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

      Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

      If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

      Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

      Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • getMaxLabelCount

      public int getMaxLabelCount()
      Returns the max number of the label buckets allowed in this index.

    • setMaxLabelCount

      public AlphabeticIndex setMaxLabelCount​(int count)
      Sets the max number of the label buckets in this index. (ICU 51 default is 99)

    • addLabels

      public AlphabeticIndex addLabels​(Locale locale)
      Adds the index characters from the given locale to the index. The labels are added to those that are already in the index; they do not replace the existing index characters. The collation order for this index is not changed; it remains that of the locale that was originally specified when creating this index.

    • addLabelRange

      public AlphabeticIndex addLabelRange​(int codePointStart, int codePointEnd)
      Adds the index characters in the range between the specified start and end code points, inclusive.

    • getBucketCount

      public int getBucketCount()
      Returns the number of the label buckets in this index.

    • getBucketIndex

      public int getBucketIndex​(String s)
      Returns the index of the bucket in which 's' should appear. Function is synchronized because underlying routine walks an iterator whose state is maintained inside the index object.

    • getBucketLabel

      public String getBucketLabel​(int index)
      Returns the label for the bucket at the given index (as returned by getBucketIndex).

    • getImmutableIndex

      public AlphabeticIndex.ImmutableIndex getImmutableIndex()
      Returns an ImmutableIndex created from this AlphabeticIndex.