Class TruffleString.FromByteArrayWithCompactionUTF32Node

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.strings.TruffleString.FromByteArrayWithCompactionUTF32Node

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

TruffleString

public abstract static class TruffleString.FromByteArrayWithCompactionUTF32Node
extends Node

Node to create a new TruffleString from a byte array. See execute(byte[], int, int, TruffleString.CompactionLevel, boolean) for details.

Since:

25.1

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.Child, Node.Children

Method Summary

Modifier and Type	Method	Description
static TruffleString.FromByteArrayWithCompactionUTF32Node	create()	Create a new TruffleString.FromByteArrayWithCompactionUTF32Node.
abstract TruffleString	execute(byte[] array, int byteOffset, int byteLength, TruffleString.CompactionLevel compactionLevel, boolean copy)	UTF-32-specific version of TruffleString.FromByteArrayNode that accepts compacted buffers.
static TruffleString.FromByteArrayWithCompactionUTF32Node	getUncached()	Get the uncached version of TruffleString.FromByteArrayWithCompactionUTF32Node.

Methods inherited from class Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, reportReplace, toString

Methods inherited from class Object

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

Method Details

execute

public abstract TruffleString execute(byte[] array,
 int byteOffset,
 int byteLength,
 TruffleString.CompactionLevel compactionLevel,
 boolean copy)

UTF-32-specific version of TruffleString.FromByteArrayNode that accepts compacted buffers. Passing TruffleString.CompactionLevel.S1 means that the string is compacted to single bytes, i.e. it is equivalent to a TruffleString.Encoding.ISO_8859_1 string. Analogously, passing TruffleString.CompactionLevel.S2 means that the buffer is equivalent to a UCS-2 string.

Examples:

byte[] array = {'a', 'b', 'c'};
TruffleString str = fromByteArrayWithCompactionUTF32Node.execute(array, 0, array.length, CompactionLevel.S1, false);
// returns a UTF-32 string "abc", re-using the byte array without copy

byte[] array = {0x34, 0x12, 0x78, 0x56};
TruffleString str = fromByteArrayWithCompactionUTF32Node.execute(array, 0, array.length, CompactionLevel.S2, false);
// returns a UTF-32 string "ሴ噸", re-using the byte array without copy

byte[] array = {0x45, 0x23, 0x01, 0x00};
TruffleString str = fromByteArrayWithCompactionUTF32Node.execute(array, 0, array.length, CompactionLevel.S4, false);
// returns a UTF-32 string containing the single codepoint 0x12345, re-using the byte array
// without copy

Note that this node may further compact (and therefore copy) the array if possible, or inflate if it contains illegal codepoints (i.e. surrogate values):

byte[] array = {'a', 0x00, 'b', 0x00};
TruffleString str = fromByteArrayWithCompactionUTF32Node.execute(array, 0, array.length, CompactionLevel.S2, false);
// returns a UTF-32 string "ab", copying and further compacting the given array despite
// copy=false

Parameters:

compactionLevel - describes the given string's compaction level. TruffleString.CompactionLevel.S1 means one byte per codepoint, TruffleString.CompactionLevel.S2 means two bytes per codepoint, and TruffleString.CompactionLevel.S4 corresponds to four bytes per codepoint. Not strictly required to be partial evaluation constant, but still recommended, since this parameter being constant avoids two branches and associated stub calls.

copy - analogous to the copy parameter of TruffleString.FromByteArrayNode. Must be partial evaluation constant.

Since:

25.1

create

public static TruffleString.FromByteArrayWithCompactionUTF32Node create()

Create a new TruffleString.FromByteArrayWithCompactionUTF32Node.

Since:

25.1

getUncached

public static TruffleString.FromByteArrayWithCompactionUTF32Node getUncached()

Get the uncached version of TruffleString.FromByteArrayWithCompactionUTF32Node.

Since:

25.1