org.apache.paimon.data

Class BinaryString

java.lang.Object

org.apache.paimon.data.BinarySection

org.apache.paimon.data.BinaryString

All Implemented Interfaces:

Serializable, Comparable<BinaryString>

@Public
public final class BinaryString
extends BinarySection
implements Comparable<BinaryString>

A string which is backed by MemorySegments.

Since:

0.4.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BinaryString	EMPTY_UTF8

Fields inherited from class org.apache.paimon.data.BinarySection

HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE, offset, segments, sizeInBytes

Constructor Summary

Constructors

Constructor and Description
BinaryString(MemorySegment[] segments, int offset, int sizeInBytes)

Method Summary

Modifier and Type	Method and Description
static BinaryString	blankString(int length) Creates a BinaryString instance that contains `length` spaces.
byte	byteAt(int index) Returns the byte value at the specified index.
int	compareTo(BinaryString other) Compares two strings lexicographically.
boolean	contains(BinaryString s) Returns true if and only if this BinaryString contains the specified sequence of bytes values.
BinaryString	copy() Copy a new BinaryString.
static String	decodeUTF8(byte[] input, int offset, int byteLen)
static String	decodeUTF8(MemorySegment input, int offset, int byteLen)
static int	decodeUTF8Strict(byte[] sa, int sp, int len, char[] da)
static int	decodeUTF8Strict(MemorySegment segment, int sp, int len, char[] da)
static String	defaultDecodeUTF8(byte[] bytes, int offset, int len)
static int	defaultEncodeUTF8(String str, byte[] bytes)
static byte[]	encodeUTF8(String str) This method must have the same result with JDK's String.getBytes.
static int	encodeUTF8(String str, byte[] bytes)
boolean	endsWith(BinaryString suffix) Tests if this BinaryString ends with the specified suffix.
static BinaryString	fromAddress(MemorySegment[] segments, int offset, int numBytes)
static BinaryString	fromBytes(byte[] bytes) Creates a BinaryString instance from the given UTF-8 bytes.
static BinaryString	fromBytes(byte[] bytes, int offset, int numBytes) Creates a BinaryString instance from the given UTF-8 bytes with offset and number of bytes.
static BinaryString	fromString(String str)
int	indexOf(BinaryString str, int fromIndex) Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.
int	numChars() Returns the number of UTF-8 code points in the string.
boolean	startsWith(BinaryString prefix) Tests if this BinaryString starts with the specified prefix.
BinaryString	substring(int beginIndex, int endIndex) Returns a binary string that is a substring of this binary string.
BinaryString	toLowerCase() Converts all of the characters in this BinaryString to lower case.
String	toString()
BinaryString	toUpperCase() Converts all of the characters in this BinaryString to upper case.
BinaryString	trim() Returns a string whose value is this string, with any leading and trailing whitespace removed.

Methods inherited from class org.apache.paimon.data.BinarySection

equals, getOffset, getSegments, getSizeInBytes, hashCode, pointTo, pointTo, toBytes

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_UTF8

public static final BinaryString EMPTY_UTF8

Constructor Detail

BinaryString

public BinaryString(MemorySegment[] segments,
                    int offset,
                    int sizeInBytes)

Method Detail

fromAddress

public static BinaryString fromAddress(MemorySegment[] segments,
                                       int offset,
                                       int numBytes)

fromString

@Nullable
public static BinaryString fromString(String str)

fromBytes

public static BinaryString fromBytes(byte[] bytes)

Creates a BinaryString instance from the given UTF-8 bytes.

fromBytes

public static BinaryString fromBytes(byte[] bytes,
                                     int offset,
                                     int numBytes)

Creates a BinaryString instance from the given UTF-8 bytes with offset and number of bytes.

blankString

public static BinaryString blankString(int length)

Creates a BinaryString instance that contains `length` spaces.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(@Nonnull
                     BinaryString other)

Compares two strings lexicographically. Since UTF-8 uses groups of six bits, it is sometimes useful to use octal notation which uses 3-bit groups. With a calculator which can convert between hexadecimal and octal it can be easier to manually create or interpret UTF-8 compared with using binary. So we just compare the binary.

Specified by:

compareTo in interface Comparable<BinaryString>

numChars

public int numChars()

Returns the number of UTF-8 code points in the string.

byteAt

public byte byteAt(int index)

Returns the byte value at the specified index. An index ranges from 0 to sizeInBytes - 1.

Parameters:

index - the index of the byte value.

Returns:

the byte value at the specified index of this UTF-8 bytes.

Throws:

IndexOutOfBoundsException - if the index argument is negative or not less than the length of this UTF-8 bytes.

copy

public BinaryString copy()

Copy a new BinaryString.

substring

public BinaryString substring(int beginIndex,
                              int endIndex)

Returns a binary string that is a substring of this binary string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1.

Examples:

 fromString("hamburger").substring(4, 8) returns binary string "urge"
 fromString("smiles").substring(1, 5) returns binary string "mile"
 

Parameters:

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

Returns:

the specified substring, return EMPTY_UTF8 when index out of bounds instead of StringIndexOutOfBoundsException.

contains

public boolean contains(BinaryString s)

Returns true if and only if this BinaryString contains the specified sequence of bytes values.

Parameters:

s - the sequence to search for

Returns:

true if this BinaryString contains s, false otherwise

startsWith

public boolean startsWith(BinaryString prefix)

Tests if this BinaryString starts with the specified prefix.

Parameters:

prefix - the prefix.

Returns:

true if the bytes represented by the argument is a prefix of the bytes represented by this string; false otherwise. Note also that true will be returned if the argument is an empty BinaryString or is equal to this BinaryString object as determined by the BinarySection.equals(Object) method.

endsWith

public boolean endsWith(BinaryString suffix)

Tests if this BinaryString ends with the specified suffix.

Parameters:

suffix - the suffix.

Returns:

true if the bytes represented by the argument is a suffix of the bytes represented by this object; false otherwise. Note that the result will be true if the argument is the empty string or is equal to this BinaryString object as determined by the BinarySection.equals(Object) method.

trim

public BinaryString trim()

Returns a string whose value is this string, with any leading and trailing whitespace removed.

Returns:

A string whose value is this string, with any leading and trailing white space removed, or this string if it has no leading or trailing white space.

indexOf

public int indexOf(BinaryString str,
                   int fromIndex)

Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

Parameters:

str - the substring to search for.

fromIndex - the index from which to start the search.

Returns:

the index of the first occurrence of the specified substring, starting at the specified index, or -1 if there is no such occurrence.

toUpperCase

public BinaryString toUpperCase()

Converts all of the characters in this BinaryString to upper case.

Returns:

the BinaryString, converted to uppercase.

toLowerCase

public BinaryString toLowerCase()

Converts all of the characters in this BinaryString to lower case.

Returns:

the BinaryString, converted to lowercase.

encodeUTF8

public static byte[] encodeUTF8(String str)

This method must have the same result with JDK's String.getBytes.

encodeUTF8

public static int encodeUTF8(String str,
                             byte[] bytes)

defaultEncodeUTF8

public static int defaultEncodeUTF8(String str,
                                    byte[] bytes)

decodeUTF8

public static String decodeUTF8(byte[] input,
                                int offset,
                                int byteLen)

decodeUTF8Strict

public static int decodeUTF8Strict(byte[] sa,
                                   int sp,
                                   int len,
                                   char[] da)

decodeUTF8

public static String decodeUTF8(MemorySegment input,
                                int offset,
                                int byteLen)

decodeUTF8Strict

public static int decodeUTF8Strict(MemorySegment segment,
                                   int sp,
                                   int len,
                                   char[] da)

defaultDecodeUTF8

public static String defaultDecodeUTF8(byte[] bytes,
                                       int offset,
                                       int len)