Package net.sf.saxon.str

Class Slice16

java.lang.Object

net.sf.saxon.str.UnicodeString

net.sf.saxon.str.Slice16

All Implemented Interfaces:

Comparable<UnicodeString>, AtomicMatchKey

public class Slice16
extends UnicodeString

A Unicode string consisting entirely of 16-bit BMP characters, implemented as a range of an underlying byte array

Constructor Summary

Constructors

Constructor	Description
Slice16(char[] chars, int start, int end)	Create a slice of an underlying char array

Method Summary

Modifier and Type	Method	Description
int	codePointAt(long index)	Get the code point at a given position in the string
IntIterator	codePoints()	Get an iterator over the code points present in the string.
char[]	getCharArray()
int	getEnd()
int	getStart()
int	getWidth()	Get the number of bits needed to hold all the characters in this string
int	hashCode()	Compute a hashCode.
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
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
long	length()	Get the length of the string
UnicodeString	substring(long start, long end)	Get a substring of this string, with a given start and end position
String	toString()	Convert to a string.

Methods inherited from class net.sf.saxon.str.UnicodeString

asAtomic, checkSubstringBounds, compareTo, concat, economize, equals, estimatedLength, hasSubstring, indexOf, indexOf, isEmpty, length32, prefix, requireInt, requireNonNegativeInt, substring, tidy, verifyCharacters

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Slice16

public Slice16(char[] chars,
 int start,
 int end)

Create a slice of an underlying char array

Parameters:

chars - the char array, containing Unicode codepoints in the range 0-65535; the caller warrants that there are no surrogate characters present

start - the offset of the first character within the character array

end - the offset of the first excluded character, so the length of the string is end-start

Method Details

length

public long length()

Description copied from class: UnicodeString

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()

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.

getCharArray

public char[] getCharArray()

getStart

public int getStart()

getEnd

public int getEnd()

indexOf

public long indexOf(int codePoint,
 long from)

Description copied from class: UnicodeString

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). A negative value is treated as zero. A position beyond the end of the string results in a return value of -1 (meaning not found).

Returns:

the position (0-based) of the first occurrence found, or -1 if not found

codePointAt

public int codePointAt(long index)

Description copied from class: UnicodeString

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

substring

public UnicodeString substring(long start,
 long end)

Description copied from class: UnicodeString

Get a substring of this string, 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

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

Throws:

UnsupportedOperationException - if the UnicodeString has not been prepared for codePoint access

codePoints

public IntIterator codePoints()

Description copied from class: UnicodeString

Get an iterator over the code points present in the string.

Specified by:

codePoints in class UnicodeString

Returns:

an iterator that delivers the individual code points

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

toString

public String toString()

Convert to a string.

Overrides:

toString in class Object