com.oracle.truffle.api.strings (GraalVM Truffle Java API Reference)

Interface Summary
Interface	Description
NativeAllocator	An allocation function for native buffers.
TranscodingErrorHandler	An error handler for transcoding operations such as `TruffleString.SwitchEncodingNode`.

Class Summary
Class	Description
AbstractTruffleString	Abstract base class for Truffle strings.
InternalByteArray	Wrapper object containing a `TruffleString`'s internal byte array, along with a byte offset and length defining the region in use.
MutableTruffleString	Represents a mutable variant of a `TruffleString`.
MutableTruffleString.AsManagedNode	Node to get the given `AbstractTruffleString` as a managed `MutableTruffleString`, meaning that the resulting string's backing memory is not a native pointer.
MutableTruffleString.AsMutableTruffleStringNode	Node to get a `AbstractTruffleString` as a `MutableTruffleString`.
MutableTruffleString.ConcatNode	Node to create a new `MutableTruffleString` by concatenating two strings.
MutableTruffleString.ForceEncodingNode	Node to forcibly assign any encoding to a string.
MutableTruffleString.FromByteArrayNode	Node to create a new `MutableTruffleString` from a byte array.
MutableTruffleString.FromNativePointerNode	Node to create a new `MutableTruffleString` from an interop object representing a native pointer.
MutableTruffleString.SubstringByteIndexNode	`MutableTruffleString.SubstringNode`, but with byte indices.
MutableTruffleString.SubstringNode	Node to create a new mutable substring of a string.
MutableTruffleString.SwitchEncodingNode	Node to get a given string in a specific encoding.
MutableTruffleString.WriteByteNode	Node to write a byte into a mutable string.
TranscodingErrorHandler.ReplacementString	Result type of `TranscodingErrorHandler.apply(AbstractTruffleString, int, int, TruffleString.Encoding, TruffleString.Encoding)`.
TruffleString	Represents a primitive String type, which can be reused across languages.
TruffleString.AsManagedNode	Node to get the given `AbstractTruffleString` as a managed `TruffleString`, meaning that the resulting string's backing memory is not a native pointer.
TruffleString.AsNativeNode	Node to convert a potentially `managed` `TruffleString` to a `native` string.
TruffleString.AsTruffleStringNode	Node to get the given `AbstractTruffleString` as a `TruffleString`.
TruffleString.ByteIndexOfAnyByteNode	Node to find the index of the first occurrence of any byte from a given array.
TruffleString.ByteIndexOfCodePointNode	`TruffleString.IndexOfCodePointNode`, but with byte indices.
TruffleString.ByteIndexOfCodePointSetNode	Node to find the byte index of the first occurrence of a codepoint present in a given codepoint set.
TruffleString.ByteIndexOfStringNode	`TruffleString.IndexOfStringNode`, but with byte indices.
TruffleString.ByteIndexToCodePointIndexNode	Node to convert a given byte index to a codepoint index.
TruffleString.ByteLengthOfCodePointNode	Node to get the number of bytes occupied by the codepoint starting at a given byte index.
TruffleString.CharIndexOfAnyCharUTF16Node	Node to find the index of the first occurrence of any `char` from a given array.
TruffleString.CodePointAtByteIndexNode	Node to read a codepoint at a given byte index.
TruffleString.CodePointAtIndexNode	Node to read a codepoint at a given codepoint index.
TruffleString.CodePointIndexToByteIndexNode	Node to convert a given codepoint index to a byte index.
TruffleString.CodePointLengthNode	Node to get the number of codepoints in a string.
TruffleString.CodePointSet	A set of codepoints in a given encoding.
TruffleString.CodeRangeEqualsNode	Node to check if a string's code range is equal to the given `TruffleString.CodeRange`.
TruffleString.CompareBytesNode	Node to compare two strings byte-by-byte.
TruffleString.CompareCharsUTF16Node	Node to compare two UTF-16 strings.
TruffleString.CompareIntsUTF32Node	Node to compare two UTF-32 strings.
TruffleString.ConcatNode	Node to concatenate two strings.
TruffleString.CopyToByteArrayNode	Node to copy a region of a string into a byte array.
TruffleString.CopyToNativeMemoryNode	Node to copy a region of a string into native memory.
TruffleString.CreateBackwardCodePointIteratorNode	Node to create a `TruffleStringIterator`.
TruffleString.CreateCodePointIteratorNode	Node to create a `TruffleStringIterator`.
TruffleString.EqualNode	Node to check two strings for equality.
TruffleString.ForceEncodingNode	Node to forcibly assign any encoding to a string.
TruffleString.FromByteArrayNode	Node to create a new `TruffleString` from a byte array.
TruffleString.FromCharArrayUTF16Node	Node to create a new UTF-16 `TruffleString` from a char array.
TruffleString.FromCodePointNode	Node to create a new `TruffleString` from a single codepoint.
TruffleString.FromIntArrayUTF32Node	Node to create a new UTF-32 `TruffleString` from an int-array.
TruffleString.FromJavaStringNode	Node to create a new `TruffleString` from a Java string.
TruffleString.FromLongNode	Node to create a new `TruffleString` from a `long` value.
TruffleString.FromNativePointerNode	Node to create a new `TruffleString` from an interop object representing a native pointer.
TruffleString.GetByteCodeRangeNode	Node to get a string's "byte-based" `TruffleString.CodeRange`.
TruffleString.GetCodeRangeImpreciseNode	Node to get a string's possibly imprecise `TruffleString.CodeRange`.
TruffleString.GetCodeRangeNode	Node to get a string's precise `TruffleString.CodeRange`.
TruffleString.GetInternalByteArrayNode	Node to get a string's internal byte array.
TruffleString.GetInternalNativePointerNode	Node to get a `native` string's pointer object.
TruffleString.GetStringCompactionLevelNode	Node to get a string's `TruffleString.CompactionLevel`.
TruffleString.HashCodeNode	Node to get a string's hash code.
TruffleString.IndexOfCodePointNode	Node to find the index of the first occurrence of a given code point.
TruffleString.IndexOfStringNode	Node to find the index of the first occurrence of a given string.
TruffleString.IntIndexOfAnyIntUTF32Node	Node to find the index of the first occurrence of any `int` from a given array.
TruffleString.IsValidNode	Node to check if a string is encoded correctly.
TruffleString.LastByteIndexOfCodePointNode	`TruffleString.LastIndexOfCodePointNode`, but with byte indices.
TruffleString.LastByteIndexOfStringNode	`TruffleString.LastIndexOfStringNode`, but with byte indices.
TruffleString.LastIndexOfCodePointNode	Node to find the codepoint index of the last occurrence of a given code point.
TruffleString.LastIndexOfStringNode	Node to find the index of the last occurrence of a given string.
TruffleString.MaterializeNode	Node to force materialization of any lazy internal data.
TruffleString.ParseDoubleNode	Node to parse a given string as a double value.
TruffleString.ParseIntNode	Node to parse a given string as an int value.
TruffleString.ParseLongNode	Node to parse a given string as a long value.
TruffleString.ReadByteNode	Node to read a single byte from a string.
TruffleString.ReadCharUTF16Node	Node to read a single char from a UTF-16 string.
TruffleString.RegionEqualByteIndexNode	Node to check for a region match, byte-by-byte.
TruffleString.RegionEqualNode	Node to check codepoint equality of two string regions.
TruffleString.RepeatNode	Node to repeat a given string `N` times.
TruffleString.SubstringByteIndexNode	`TruffleString.SubstringNode`, but with byte indices.
TruffleString.SubstringNode	Node to create a substring of a given string.
TruffleString.SwitchEncodingNode	Node to get a given string in a specific encoding.
TruffleString.ToJavaStringNode	Node to get a `String` representation of a `TruffleString`.
TruffleString.WithMask	Extended parameter type for the operations `TruffleString.ByteIndexOfStringNode`, `TruffleString.LastByteIndexOfStringNode` and `TruffleString.RegionEqualByteIndexNode`.
TruffleString.WithMask.CreateNode	Node to create a new `TruffleString.WithMask` from a string and a byte array.
TruffleString.WithMask.CreateUTF16Node	Node to create a new `TruffleString.WithMask` from a UTF-16 string and a char array.
TruffleString.WithMask.CreateUTF32Node	Node to create a new `TruffleString.WithMask` from a UTF-32 string and an int array.
TruffleStringBuilder	The `TruffleString` equivalent to `StringBuilder`.
TruffleStringBuilder.AppendByteNode	Node to append a single byte to a string builder.
TruffleStringBuilder.AppendCharUTF16Node	Node to append a single char to a string builder.
TruffleStringBuilder.AppendCodePointNode	Node to append a codepoint to a string builder.
TruffleStringBuilder.AppendIntNumberNode	Node to append an integer to a string builder.
TruffleStringBuilder.AppendJavaStringUTF16Node	Node to append a substring of a given `String` to a string builder.
TruffleStringBuilder.AppendLongNumberNode	Node to append a `long` value to a string builder.
TruffleStringBuilder.AppendStringNode	Node to append a given `TruffleString` to a string builder.
TruffleStringBuilder.AppendSubstringByteIndexNode	Node to append a substring of a given `TruffleString` to a string builder.
TruffleStringBuilder.ToStringNode	Node to materialize a string builder as a `TruffleString`.
TruffleStringBuilderUTF16	The UTF-16-specific variant of `TruffleStringBuilder`.
TruffleStringBuilderUTF32	The UTF-32-specific variant of `TruffleStringBuilder`.
TruffleStringBuilderUTF8	The UTF-8-specific variant of `TruffleStringBuilder`.
TruffleStringIterator	An iterator object that allows iterating over a `TruffleString`'s codepoints, without having to re-calculate codepoint indices on every access.
TruffleStringIterator.NextNode	Returns the next codepoint in the string.
TruffleStringIterator.PreviousNode	Returns the previous codepoint in the string.

Enum Summary
Enum	Description
TruffleString.CodeRange	Provides information about a string's content.
TruffleString.CompactionLevel	Represents a string's compaction level, i.e.
TruffleString.Encoding	The list of encodings supported by `TruffleString`.
TruffleString.ErrorHandling	Error handling instructions for operations that return integer values, such as indices or code points.

Exception Summary
Exception	Description
TruffleString.IllegalByteArrayLengthException	This exception is thrown when any operation tries to create a `UTF-16` or `UTF-32` string with an invalid byte length (not a multiple of 2/4 bytes).
TruffleString.NumberFormatException	This exception may be thrown by `TruffleString.ParseIntNode`, `TruffleString.ParseLongNode` or `TruffleString.ParseDoubleNode` to indicate that the given string cannot be parsed as an integer, long or double value.

Package com.oracle.truffle.api.strings Description

Truffle String related APIs. Please see the tutorial for further usage instructions.

Since:: 22.1