Class UnicodeChar

java.lang.Object
net.sf.saxon.str.UnicodeString
net.sf.saxon.str.UnicodeChar
All Implemented Interfaces:
Comparable<UnicodeString>, AtomicMatchKey
public class UnicodeChar extends UnicodeString
A UnicodeString containing a single codepoint

  • Constructor Details

    • UnicodeChar

      public UnicodeChar(int codepoint)

  • Method Details

    • codePoints

      public IntIterator codePoints()
      Get an iterator over the code points present in the string. Note that this method is always available, whether or not the UnicodeString has been prepared for codePoint access.
      Specified by:
      codePoints in class UnicodeString
      Returns:
      an iterator that delivers the individual code points

    • getCodepoint

      public int getCodepoint()
      Get the codepoint represented by this UnicodeChar
      Returns:
      the relevant codepoint

    • length

      public long length()
      Get the length of the string
      Specified by:
      length in class UnicodeString
      Returns:
      the number of code points in the string

    • getWidth

      public int getWidth()
      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, 8 for latin-1, 16 for BMP, 24 for general Unicode.

    • indexOf

      public long indexOf(int codePoint, 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:
      indexOf in class UnicodeString
      Parameters:
      codePoint - the sought codePoint
      from - the position from which the search should start (0-based)
      Returns:
      the position (0-based) of the first occurrence found, or -1 if not found

    • codePointAt

      public int codePointAt(long index)
      Get the code point at a given position in the string
      Specified by:
      codePointAt in class UnicodeString
      Parameters:
      index - the given position (0-based)
      Returns:
      the code point at the given position
      Throws:
      IndexOutOfBoundsException - if index is not zero

    • substring

      public UnicodeString substring(long start, long end)
      Get a substring of this codepoint sequence, with a given start and end position
      Specified by:
      substring in class UnicodeString
      Parameters:
      start - the start position (0-based): that is, the position of the first code point to be included
      end - the end position (0-based): specifically, the position of the first code point not to be included
      Returns:
      the requested substring
      Throws:
      IndexOutOfBoundsException - if the start/end positions are out of range

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • copy8bit

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

    • 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