Class Twine16

  • All Implemented Interfaces:
    Comparable<UnicodeString>, AtomicMatchKey

    public class Twine16
    extends UnicodeString
    Twine16 is a Unicode string consisting entirely of codepoints in the range 0-65535 (that is, the basic multilingual plane), excluding surrogates. The number of codepoints is limited to 2^31-1.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int cachedHash  
      protected char[] chars  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Twine16​(char[] chars)
      Protected constructor
        Twine16​(char[] chars, int start, int len)
      Constructor taking an array of 16-bit chars, or a substring thereof.
    • Field Detail

      • chars

        protected char[] chars
      • cachedHash

        protected int cachedHash
    • Constructor Detail

      • Twine16

        protected Twine16​(char[] chars)
        Protected constructor
        Parameters:
        chars - the 16-bit characters comprising the string: must not include any surrogates
      • Twine16

        public Twine16​(char[] chars,
                       int start,
                       int len)
        Constructor taking an array of 16-bit chars, or a substring thereof. The caller warrants that the characters are all BMP characters (no surrogate pairs). The character array is copied, so it can be reused and modified after the call.
        Parameters:
        chars - the array of characters (must not include any surrogates)
        start - start offset into the array
        len - the number of characters to be included.
    • Method Detail

      • getCharArray

        public char[] getCharArray()
      • length

        public long length()
        Get the length of this string, in codepoints
        Specified by:
        length in class UnicodeString
        Returns:
        the length of the string in Unicode code points
      • length32

        public int length32()
        Description copied from class: UnicodeString
        Get the length of the string, provided it is less than 2^31 characters
        Overrides:
        length32 in class UnicodeString
        Returns:
        the length of the string if it fits within a Java int
      • substring

        public UnicodeString substring​(long start,
                                       long end)
        Get a substring of this string (following the rules of String.substring(int), but measuring Unicode codepoints rather than 16-bit code units)
        Specified by:
        substring in class UnicodeString
        Parameters:
        start - the offset of the first character to be included in the result, counting Unicode codepoints
        end - the offset of the first character to be excluded from the result, counting Unicode codepoints
        Returns:
        the substring
      • indexOf

        public long indexOf​(int codePoint,
                            long from)
        Get the first position, at or beyond start, where a given codepoint appears in this string.
        Specified by:
        indexOf in class UnicodeString
        Parameters:
        codePoint - the sought codepoint
        from - the position (0-based) where searching is to start (counting in codepoints)
        Returns:
        the first position where the substring is found, or -1 if it is not found
      • indexOf

        public long indexOf​(UnicodeString other,
                            long from)
        Get the first position, at or beyond start, where another string appears as a substring of this string, comparing codepoints.
        Overrides:
        indexOf in class UnicodeString
        Parameters:
        other - the other (sought) string
        from - the position (0-based) where searching is to start (counting in codepoints)
        Returns:
        the first position where the substring is found, or -1 if it is not found
      • isEmpty

        public boolean isEmpty()
        Determine whether the string is a zero-length string. This may be more efficient than testing whether the length is equal to zero
        Overrides:
        isEmpty in class UnicodeString
        Returns:
        true if the string is zero length
      • copy16bit

        void copy16bit​(char[] target,
                       int offset)
        Description copied from class: UnicodeString
        Copy this string, as a sequence of 16-bit characters, to a specified array
        Overrides:
        copy16bit in class UnicodeString
        Parameters:
        target - the target array: the caller must ensure there is sufficient capacity
        offset - the position in the target array
      • copy24bit

        void copy24bit​(byte[] target,
                       int offset)
        Description copied from class: UnicodeString
        Copy this string, as a sequence of 24-bit characters, to a specified array
        Overrides:
        copy24bit in class UnicodeString
        Parameters:
        target - the target array: the caller must ensure there is sufficient capacity
        offset - the position in the target array as a byte offset (that is, the character offset times 3)
      • copy32bit

        void copy32bit​(int[] target,
                       int offset)
        Description copied from class: UnicodeString
        Copy this string, as a sequence of 32-bit codepoints, to a specified array
        Overrides:
        copy32bit in class UnicodeString
        Parameters:
        target - the target array: the caller must ensure there is sufficient capacity
        offset - the position in the target array as a codepoint offset
      • getWidth

        public int getWidth()
        Description copied from class: UnicodeString
        Get the number of bits needed to hold all the characters in this string
        Specified by:
        getWidth in class UnicodeString
        Returns:
        7 for ascii characters (not used??), 8 for latin-1, 16 for BMP, 24 for general Unicode.
      • codePoints

        public IntIterator codePoints()
        Get an iterator over the Unicode codepoints in the value. These will always be full codepoints, never surrogates (surrogate pairs are combined where necessary).
        Specified by:
        codePoints in class UnicodeString
        Returns:
        a sequence of Unicode codepoints
      • hashCode

        public int hashCode()
        Compute a hashCode. All implementations of UnicodeString use compatible hash codes and the hashing algorithm is therefore identical to that for java.lang.String. This means that for strings containing Astral characters, the hash code needs to be computed by decomposing an Astral character into a surrogate pair.
        Overrides:
        hashCode in class UnicodeString
        Returns:
        the hash code
      • equals

        public boolean equals​(Object o)
        Test whether this StringValue is equal to another under the rules of the codepoint collation. The type annotation is ignored.
        Overrides:
        equals in class UnicodeString
        Parameters:
        o - the value to be compared with this value
        Returns:
        true if the strings are equal on a codepoint-by-codepoint basis
      • compareTo

        public int compareTo​(UnicodeString other)
        Description copied from class: UnicodeString
        Compare this string to another using codepoint comparison
        Specified by:
        compareTo in interface Comparable<UnicodeString>
        Overrides:
        compareTo in class UnicodeString
        Parameters:
        other - the other string
        Returns:
        -1 if this string comes first, 0 if they are equal, +1 if the other string comes first
      • indexWhere

        public long indexWhere​(IntPredicate predicate,
                               long from)
        Get the position of the first occurrence of the specified codepoint, starting the search at a given position in the string
        Specified by:
        indexWhere in class UnicodeString
        Parameters:
        predicate - condition that the codepoint must satisfy
        from - the position from which the search should start (0-based)
        Returns:
        the position (0-based) of the first codepoint to match the predicate, or -1 if not found
      • details

        public String details()