Class UnicodeMap<T>

java.lang.Object
org.graalvm.shadowed.com.ibm.icu.impl.UnicodeMap<T>
All Implemented Interfaces:
Cloneable, Iterable<String>, StringTransform, Transform<String,String>, Freezable<UnicodeMap<T>>
public final class UnicodeMap<T> extends Object implements Cloneable, Freezable<UnicodeMap<T>>, StringTransform, Iterable<String>
Class for mapping Unicode characters and strings to values, optimized for single code points, where ranges of code points have the same value. Much smaller storage than using HashMap, and much faster and more compact than a list of UnicodeSets. The API design mimics Mapinvalid input: '<'String,T> but can't extend it due to some necessary changes (much as UnicodeSet mimics Set). Note that nulls are not permitted as values; that is, a put(x,null) is the same as remove(x).
At this point "" is also not allowed as a key, although that may change.

  • Constructor Details

    • UnicodeMap

      public UnicodeMap()

    • UnicodeMap

      public UnicodeMap(UnicodeMap other)

  • Method Details

    • clear

      public UnicodeMap<T> clear()

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • areEqual

      public static boolean areEqual(Object a, Object b)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • cloneAsThawed

      public UnicodeMap<T> cloneAsThawed()
      Standard clone. Warning, as with Collections, does not do deep clone.
      Specified by:
      cloneAsThawed in interface Freezable<T>

    • put

      public UnicodeMap<T> put(int codepoint, T value)
      Sets the codepoint value.
      Parameters:
      codepoint -
      value -
      Returns:
      this (for chaining)

    • put

      public UnicodeMap<T> put(String string, T value)
      Sets the codepoint value.
      Parameters:
      value -
      codepoint -
      Returns:
      this (for chaining)

    • putAll

      public UnicodeMap<T> putAll(UnicodeSet codepoints, T value)
      Adds bunch o' codepoints; otherwise like put.
      Parameters:
      codepoints -
      value -
      Returns:
      this (for chaining)

    • putAll

      public UnicodeMap<T> putAll(int startCodePoint, int endCodePoint, T value)
      Adds bunch o' codepoints; otherwise like add.
      Parameters:
      startCodePoint -
      endCodePoint -
      value -
      Returns:
      this (for chaining)

    • putAll

      public UnicodeMap<T> putAll(UnicodeMap<T> unicodeMap)
      Add all the (main) values from a UnicodeMap
      Parameters:
      unicodeMap - the property to add to the map
      Returns:
      this (for chaining)

    • putAllFiltered

      public UnicodeMap<T> putAllFiltered(UnicodeMap<T> prop, UnicodeSet filter)
      Add all the (main) values from a Unicode property
      Parameters:
      prop - the property to add to the map
      Returns:
      this (for chaining)

    • setMissing

      public UnicodeMap<T> setMissing(T value)
      Set the currently unmapped Unicode code points to the given value.
      Parameters:
      value - the value to set
      Returns:
      this (for chaining)

    • keySet

      public UnicodeSet keySet(T value, UnicodeSet result)
      Returns the keyset consisting of all the keys that would produce the given value. Deposits into result if it is not null. Remember to clear if you just want the new values.

    • keySet

      public UnicodeSet keySet(T value)
      Returns the keyset consisting of all the keys that would produce the given value. the new values.

    • keySet

      public UnicodeSet keySet()
      Returns the keyset consisting of all the keys that would produce (non-null) values.

    • values

      public <U extends Collection<T>> U values(U result)
      Returns the list of possible values. Deposits each non-null value into result. Creates result if it is null. Remember to clear result if you are not appending to existing collection.
      Parameters:
      result -
      Returns:
      result

    • values

      public Set<T> values()
      Convenience method

    • get

      public T get(int codepoint)
      Gets the value associated with a given code point. Returns null, if there is no such value.
      Parameters:
      codepoint -
      Returns:
      the value

    • get

      public T get(String value)
      Gets the value associated with a given code point. Returns null, if there is no such value.
      Parameters:
      codepoint -
      Returns:
      the value

    • transform

      public String transform(String source)
      Change a new string from the source string according to the mappings. For each code point cp, if getValue(cp) is null, append the character, otherwise append getValue(cp).toString() TODO: extend to strings
      Specified by:
      transform in interface StringTransform
      Specified by:
      transform in interface Transform<String,String>
      Parameters:
      source -
      Returns:

    • composeWith

      public UnicodeMap<T> composeWith(UnicodeMap<T> other, UnicodeMap.Composer<T> composer)

    • composeWith

      public UnicodeMap<T> composeWith(UnicodeSet set, T value, UnicodeMap.Composer<T> composer)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(Comparator<T> collected)

    • getErrorOnReset

      public boolean getErrorOnReset()
      Returns:
      Returns the errorOnReset value.

    • setErrorOnReset

      public UnicodeMap<T> setErrorOnReset(boolean errorOnReset)
      Puts the UnicodeMap into a state whereby new mappings are accepted, but changes to old mappings cause an exception.
      Parameters:
      errorOnReset - The errorOnReset to set.

    • isFrozen

      public boolean isFrozen()
      Description copied from interface: Freezable
      Determines whether the object has been frozen or not.
      Specified by:
      isFrozen in interface Freezable<T>

    • freeze

      public UnicodeMap<T> freeze()
      Description copied from interface: Freezable
      Freezes the object.
      Specified by:
      freeze in interface Freezable<T>
      Returns:
      the object itself.

    • findCommonPrefix

      public static int findCommonPrefix(String last, String s)
      Utility to find the maximal common prefix of two strings. TODO: fix supplemental support

    • getRangeCount

      public int getRangeCount()
      Get the number of ranges; used for getRangeStart/End. The ranges together cover all of the single-codepoint keys in the UnicodeMap. Other keys can be gotten with getStrings().

    • getRangeStart

      public int getRangeStart(int range)
      Get the start of a range. All code points between start and end are in the UnicodeMap's keyset.

    • getRangeEnd

      public int getRangeEnd(int range)
      Get the start of a range. All code points between start and end are in the UnicodeMap's keyset.

    • getRangeValue

      public T getRangeValue(int range)
      Get the value for the range.

    • getNonRangeStrings

      public Set<String> getNonRangeStrings()
      Get the strings that are not in the ranges. Returns null if there are none.
      Returns:

    • containsKey

      public boolean containsKey(String key)

    • containsKey

      public boolean containsKey(int key)

    • containsValue

      public boolean containsValue(T value)

    • isEmpty

      public boolean isEmpty()

    • putAll

      public UnicodeMap<T> putAll(Map<? extends String, ? extends T> map)

    • putAllIn

      public UnicodeMap<T> putAllIn(Map<? super String, ? super T> map)
      Deprecated.
      Utility for extracting map

    • putAllInto

      public <U extends Map<String,T>> U putAllInto(U map)
      Utility for extracting map

    • putAllCodepointsInto

      public <U extends Map<Integer,T>> U putAllCodepointsInto(U map)
      Utility for extracting map

    • remove

      public UnicodeMap<T> remove(String key)

    • remove

      public UnicodeMap<T> remove(int key)

    • size

      public int size()

    • entrySet

      public Iterable<Map.Entry<String,T>> entrySet()

    • entryRanges

      public Iterable<UnicodeMap.EntryRange<T>> entryRanges()
      Returns an Iterable over EntryRange, designed for efficient for loops over UnicodeMaps. Caution: For efficiency, the EntryRange may be reused, so the EntryRange may change on each iteration! The value is guaranteed never to be null. The entryRange.string values (non-null) are after all the ranges.
      Returns:
      entry range, for for loops

    • iterator

      public Iterator<String> iterator()
      Specified by:
      iterator in interface Iterable<T>

    • getValue

      public T getValue(String key)
      Old form for compatibility

    • getValue

      public T getValue(int key)
      Old form for compatibility

    • getAvailableValues

      public Collection<T> getAvailableValues()
      Old form for compatibility

    • getAvailableValues

      public <U extends Collection<T>> U getAvailableValues(U result)
      Old form for compatibility

    • getSet

      public UnicodeSet getSet(T value)
      Old form for compatibility

    • getSet

      public UnicodeSet getSet(T value, UnicodeSet result)
      Old form for compatibility

    • removeAll

      public final UnicodeMap<T> removeAll(UnicodeSet set)

    • removeAll

      public final UnicodeMap<T> removeAll(UnicodeMap<T> reference)

    • retainAll

      public final UnicodeMap<T> retainAll(UnicodeSet set)

    • retainAll

      public final UnicodeMap<T> retainAll(UnicodeMap<T> reference)

    • stringKeys

      public final Set<String> stringKeys()
      Returns the keys that consist of multiple code points.
      Returns:

    • addInverseTo

      public <U extends Map<T, UnicodeSet>> U addInverseTo(U target)
      Gets the inverse of this map, adding to the target. Like putAllIn
      Returns:

    • freeze

      public static <T> Map<T, UnicodeSet> freeze(Map<T, UnicodeSet> target)
      Freeze an inverse map.
      Parameters:
      target -
      Returns:

    • putAllInverse

      public UnicodeMap<T> putAllInverse(Map<T, UnicodeSet> source)
      Parameters:
      target -
      Returns: