Encodes Strings to UTF-8. Instances of this class are reusable but are NOT threadsafe. Instances are vended by Utf8StringEncoderPool#getOrCreate(). encode(String) can be called any number of times. Users are expected to call close() when the encoder is no longer needed.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Utf8StringEncoder.Result Represents the result of a `Utf8StringEncoder#encode(String)` operation.

Modifier and Type	Field and Description
pack-priv final char[]	charArray
pack-priv final CharBuffer	charBuffer
private static final int	SMALL_STRING_SIZE
pack-priv final CharsetEncoder	utf8Encoder
pack-priv final ByteBuffer	utf8EncodingBuffer

Access	Constructor and Description
pack-priv	Utf8StringEncoder(Pool<Utf8StringEncoder> pool)

Method Summary

Modifier and Type	Method and Description
public Utf8StringEncoder.Result	Returns: A `Result` containing a byte array of UTF-8 bytes and encoded length. encode(String A Java String to encode as UTF8 bytes. text) Encodes the provided String's text to UTF-8.

Inherited from com.amazon.ion.impl.bin.utf8.Poolable:: close

charArray	back to summary
pack-priv final char[] charArray

charBuffer	back to summary
pack-priv final CharBuffer charBuffer

SMALL_STRING_SIZE	back to summary
private static final int SMALL_STRING_SIZE

utf8Encoder	back to summary
pack-priv final CharsetEncoder utf8Encoder

utf8EncodingBuffer	back to summary
pack-priv final ByteBuffer utf8EncodingBuffer

Utf8StringEncoder	back to summary
pack-priv Utf8StringEncoder(Pool<Utf8StringEncoder> pool)

Method Detail

encode back to summary

encode	back to summary
public Utf8StringEncoder.Result encode(String text) Encodes the provided String's text to UTF-8. Unlike `String#getBytes(Charset)`, this method will not silently replace characters that cannot be encoded with a substitute character. Instead, it will throw an `IllegalArgumentException`. Some resources in the returned `Result` may be reused across calls to this method. Consequently, callers should use the Result and discard it immediately. Parameters text:String A Java String to encode as UTF8 bytes. Returns:Utf8StringEncoder.Result A `Result` containing a byte array of UTF-8 bytes and encoded length. Exceptions IllegalArgumentException: if the String cannot be encoded as UTF-8.

public Utf8StringEncoder.Result encode(String text)

Encodes the provided String's text to UTF-8. Unlike String#getBytes(Charset), this method will not silently replace characters that cannot be encoded with a substitute character. Instead, it will throw an IllegalArgumentException. Some resources in the returned Result may be reused across calls to this method. Consequently, callers should use the Result and discard it immediately.

Parameters

text:String: A Java String to encode as UTF8 bytes.

Returns:Utf8StringEncoder.Result

A Result containing a byte array of UTF-8 bytes and encoded length.

Exceptions

IllegalArgumentException:: if the String cannot be encoded as UTF-8.

com.amazon.ion.impl.bin.utf8 back to summary

public Class Utf8StringEncoder.Result

Class Inheritance

extends Object

java.lang.Object
com.amazon.ion.impl.bin.utf8.Utf8StringEncoder.Result

Represents the result of a Utf8StringEncoder#encode(String) operation.

Field Summary

Modifier and Type	Field and Description
private final byte[]	buffer
private final int	encodedLength

Constructor Summary

Access	Constructor and Description
public	Result(int encodedLength, byte[] buffer)

Method Summary

Modifier and Type	Method and Description
public byte[]	Returns: the buffer containing UTF-8 bytes. getBuffer() Returns a byte array containing the encoded UTF-8 bytes starting at index 0.
public int	Returns: the number of encoded bytes in the array returned by `getBuffer()`. getEncodedLength()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffer	back to summary
private final byte[] buffer

encodedLength	back to summary
private final int encodedLength

Constructor Detail

Result	back to summary
public Result(int encodedLength, byte[] buffer)

Method Detail

getBuffer back to summary

getBuffer	back to summary
public byte[] getBuffer() Returns a byte array containing the encoded UTF-8 bytes starting at index 0. This byte array is NOT guaranteed to be the same length as the data it contains. Callers must use `getEncodedLength()` to determine the number of bytes that should be read from the byte array. Returns:byte[] the buffer containing UTF-8 bytes.

public byte[] getBuffer()

Returns a byte array containing the encoded UTF-8 bytes starting at index 0. This byte array is NOT guaranteed to be the same length as the data it contains. Callers must use getEncodedLength() to determine the number of bytes that should be read from the byte array.

Returns:byte[]: the buffer containing UTF-8 bytes.

getEncodedLength	back to summary
public int getEncodedLength() Returns:int the number of encoded bytes in the array returned by `getBuffer()`.