Class GeneralUnicodeString

java.lang.Object
net.sf.saxon.regex.UnicodeString
net.sf.saxon.regex.GeneralUnicodeString
All Implemented Interfaces:
CharSequence, Comparable<UnicodeString>, AtomicMatchKey

public final class GeneralUnicodeString extends UnicodeString
A Unicode string which, in general, may contain non-BMP characters (that is, codepoints outside the range 0-65535)
  • Constructor Details

    • GeneralUnicodeString

      public GeneralUnicodeString(CharSequence in)
    • GeneralUnicodeString

      GeneralUnicodeString(int[] chars, int start, int end)
  • Method Details

    • uSubstring

      public UnicodeString uSubstring(int beginIndex, int endIndex)
      Description copied from class: UnicodeString
      Get a substring of this string
      Specified by:
      uSubstring in class UnicodeString
      Parameters:
      beginIndex - the index of the first character to be included (counting codepoints, not 16-bit characters)
      endIndex - the index of the first character to be NOT included (counting codepoints, not 16-bit characters)
      Returns:
      a substring
    • uCharAt

      public int uCharAt(int pos)
      Description copied from class: UnicodeString
      Get the character at a specified position
      Specified by:
      uCharAt in class UnicodeString
      Parameters:
      pos - the index of the required character (counting codepoints, not 16-bit characters)
      Returns:
      a character (Unicode codepoint) at the specified position.
    • uIndexOf

      public int uIndexOf(int search, int pos)
      Description copied from class: UnicodeString
      Get the first match for a given character
      Specified by:
      uIndexOf in class UnicodeString
      Parameters:
      search - the character to look for
      pos - the first position to look
      Returns:
      the position of the first occurrence of the sought character, or -1 if not found
    • uLength

      public int uLength()
      Description copied from class: UnicodeString
      Get the length of the string, in Unicode codepoints
      Specified by:
      uLength in class UnicodeString
      Returns:
      the number of codepoints in the string
    • isEnd

      public boolean isEnd(int pos)
      Description copied from class: UnicodeString
      Ask whether a given position is at (or beyond) the end of the string
      Specified by:
      isEnd in class UnicodeString
      Parameters:
      pos - the index of the required character (counting codepoints, not 16-bit characters)
      Returns:
      true iff if the specified index is after the end of the character stream
    • toString

      public String toString()
      Specified by:
      toString in interface CharSequence
      Overrides:
      toString in class Object
    • length

      public int length()
      Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.
      Returns:
      the number of chars in this sequence
    • charAt

      public char charAt(int index)
      Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

      If the char value specified by the index is a surrogate, the surrogate value is returned.

      Parameters:
      index - the index of the char value to be returned
      Returns:
      the specified char value
      Throws:
      IndexOutOfBoundsException - if the index argument is negative or not less than length()
    • subSequence

      public CharSequence subSequence(int start, int end)
      Returns a new CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.
      Parameters:
      start - the start index, inclusive
      end - the end index, exclusive
      Returns:
      the specified subsequence
      Throws:
      IndexOutOfBoundsException - if start or end are negative, if end is greater than length(), or if start is greater than end