Class CodePointTrie.Fast

java.lang.Object

com.ibm.icu.util.CodePointMap

com.ibm.icu.util.CodePointTrie

com.ibm.icu.util.CodePointTrie.Fast

All Implemented Interfaces:

Iterable<CodePointMap.Range>

Direct Known Subclasses:

CodePointTrie.Fast16, CodePointTrie.Fast32, CodePointTrie.Fast8

Enclosing class:

CodePointTrie

public abstract static class CodePointTrie.Fast
extends CodePointTrie

A CodePointTrie with CodePointTrie.Type.FAST.

Status:

Stable ICU 63.

Nested Class Summary

Nested classes/interfaces inherited from class CodePointTrie

CodePointTrie.Fast, CodePointTrie.Fast16, CodePointTrie.Fast32, CodePointTrie.Fast8, CodePointTrie.Small, CodePointTrie.Small16, CodePointTrie.Small32, CodePointTrie.Small8, CodePointTrie.Type, CodePointTrie.ValueWidth

Modifier and Type	Class	Description
static class	CodePointTrie.Fast	A CodePointTrie with CodePointTrie.Type.FAST.
static final class	CodePointTrie.Fast16	A CodePointTrie with CodePointTrie.Type.FAST and CodePointTrie.ValueWidth.BITS_16.
static final class	CodePointTrie.Fast32	A CodePointTrie with CodePointTrie.Type.FAST and CodePointTrie.ValueWidth.BITS_32.
static final class	CodePointTrie.Fast8	A CodePointTrie with CodePointTrie.Type.FAST and CodePointTrie.ValueWidth.BITS_8.
static class	CodePointTrie.Small	A CodePointTrie with CodePointTrie.Type.SMALL.
static final class	CodePointTrie.Small16	A CodePointTrie with CodePointTrie.Type.SMALL and CodePointTrie.ValueWidth.BITS_16.
static final class	CodePointTrie.Small32	A CodePointTrie with CodePointTrie.Type.SMALL and CodePointTrie.ValueWidth.BITS_32.
static final class	CodePointTrie.Small8	A CodePointTrie with CodePointTrie.Type.SMALL and CodePointTrie.ValueWidth.BITS_8.
static enum	CodePointTrie.Type	Selectors for the type of a CodePointTrie.
static enum	CodePointTrie.ValueWidth	Selectors for the number of bits in a CodePointTrie data value.

Nested classes/interfaces inherited from class CodePointMap

CodePointMap.Range, CodePointMap.RangeOption, CodePointMap.StringIterator, CodePointMap.ValueFilter

Modifier and Type	Class	Description
static final class	CodePointMap.Range	Range iteration result data.
static enum	CodePointMap.RangeOption	Selectors for how getRange() should report value ranges overlapping with surrogates.
class	CodePointMap.StringIterator	Iterates over code points of a string and fetches map values.
static interface	CodePointMap.ValueFilter	Callback function interface: Modifies a map value.

Field Summary

Fields inherited from class CodePointTrie

data, dataLength, highStart

Modifier and Type	Field	Description
protected final com.ibm.icu.util.CodePointTrie.Data	data	Deprecated. This API is ICU internal only.
protected final int	dataLength	Deprecated. This API is ICU internal only.
protected final int	highStart	Deprecated. This API is ICU internal only.

Method Summary

Modifier and Type	Method	Description
abstract int	bmpGet(int c)	Returns a trie value for a BMP code point (U+0000..U+FFFF), without range checking.
protected final int	cpIndex(int c)	Deprecated. This API is ICU internal only.
static CodePointTrie.Fast	fromBinary(CodePointTrie.ValueWidth valueWidth, ByteBuffer bytes)	Creates a trie from its binary form.
final CodePointTrie.Type	getType()	Returns the trie type.
final CodePointMap.StringIterator	stringIterator(CharSequence s, int sIndex)	Returns an iterator (not a java.util.Iterator) over code points of a string for fetching map values.
abstract int	suppGet(int c)	Returns a trie value for a supplementary code point (U+10000..U+10FFFF), without range checking.

Methods inherited from class CodePointTrie

asciiGet, fastIndex, fromBinary, get, getRange, getValueWidth, smallIndex, toBinary

Modifier and Type	Method	Description
final int	asciiGet(int c)	Returns a trie value for an ASCII code point, without range checking.
protected final int	fastIndex(int c)	Deprecated. This API is ICU internal only.
static CodePointTrie	fromBinary(CodePointTrie.Type type, CodePointTrie.ValueWidth valueWidth, ByteBuffer bytes)	Creates a trie from its binary form, stored in the ByteBuffer starting at the current position.
int	get(int c)	Returns the value for a code point as stored in the map, with range checking.
final boolean	getRange(int start, CodePointMap.ValueFilter filter, CodePointMap.Range range)	Sets the range object to a range of code points beginning with the start parameter.
final CodePointTrie.ValueWidth	getValueWidth()	Returns the number of bits in a trie data value.
protected final int	smallIndex(CodePointTrie.Type type, int c)	Deprecated. This API is ICU internal only.
final int	toBinary(OutputStream os)	Writes a representation of the trie to the output stream.

Methods inherited from class CodePointMap

getRange, iterator

Modifier and Type	Method	Description
boolean	getRange(int start, CodePointMap.RangeOption option, int surrogateValue, CodePointMap.ValueFilter filter, CodePointMap.Range range)	Sets the range object to a range of code points beginning with the start parameter.
Iterator<CodePointMap.Range>	iterator()	Convenience iterator over same-map-value code point ranges.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Method Details

fromBinary

public static CodePointTrie.Fast fromBinary(CodePointTrie.ValueWidth valueWidth,
 ByteBuffer bytes)

Creates a trie from its binary form. Same as CodePointTrie.fromBinary(Type, ValueWidth, ByteBuffer) with CodePointTrie.Type.FAST.

Parameters:

valueWidth - selects the number of bits in a data value; this method throws an exception if the valueWidth does not match the binary data; use null to accept any data value width

bytes - a buffer containing the binary data of a CodePointTrie

Returns:

the trie

Status:

Stable ICU 63.

getType

public final CodePointTrie.Type getType()

Description copied from class: CodePointTrie

Returns the trie type.

Specified by:

getType in class CodePointTrie

Returns:

CodePointTrie.Type.FAST

Status:

Stable ICU 63.

bmpGet

public abstract int bmpGet(int c)

Returns a trie value for a BMP code point (U+0000..U+FFFF), without range checking. Can be used to look up a value for a UTF-16 code unit if other parts of the string processing check for surrogates.

Parameters:

c - the input code point, must be U+0000..U+FFFF

Returns:

The BMP code point's trie value.

Status:

Stable ICU 63.

suppGet

public abstract int suppGet(int c)

Returns a trie value for a supplementary code point (U+10000..U+10FFFF), without range checking.

Parameters:

c - the input code point, must be U+10000..U+10FFFF

Returns:

The supplementary code point's trie value.

Status:

Stable ICU 63.

cpIndex

@Deprecated
protected final int cpIndex(int c)

Deprecated.

This API is ICU internal only.

Specified by:

cpIndex in class CodePointTrie

Status:

Internal. This API is ICU internal only.

stringIterator

public final CodePointMap.StringIterator stringIterator(CharSequence s,
 int sIndex)

Returns an iterator (not a java.util.Iterator) over code points of a string for fetching map values.

Overrides:

stringIterator in class CodePointMap

Parameters:

s - string to iterate over

sIndex - string index where the iteration will start

Returns:

the iterator

Status:

Stable ICU 63.