org.mariadb.jdbc.MariaDbClob Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mariadb-java-client Show documentation
Show all versions of mariadb-java-client Show documentation
JDBC driver for MariaDB and MySQL
The newest version!
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (c) 2012-2014 Monty Program Ab
// Copyright (c) 2015-2024 MariaDB Corporation Ab
package org.mariadb.jdbc;
import java.io.*;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.StandardCharsets;
import java.sql.Clob;
import java.sql.NClob;
import java.sql.SQLException;
/** MariaDB Clob implementation */
public class MariaDbClob extends MariaDbBlob implements Clob, NClob, Serializable {
private static final long serialVersionUID = -3066501059817815286L;
/**
* Creates a Clob with content.
*
* @param bytes the content for the Clob.
*/
public MariaDbClob(byte[] bytes) {
super(bytes);
}
/**
* Creates a Clob with content.
*
* @param bytes the content for the Clob.
* @param offset offset
* @param length length
*/
public MariaDbClob(byte[] bytes, int offset, int length) {
super(bytes, offset, length);
}
/** Creates an empty Clob. */
public MariaDbClob() {
super();
}
/**
* ToString implementation.
*
* @return string value of blob content.
*/
public String toString() {
return new String(data, offset, length, StandardCharsets.UTF_8);
}
/**
* Get sub string.
*
* @param pos position
* @param length length of sub string
* @return substring
* @throws SQLException if pos is less than 1 or length is less than 0
*/
public String getSubString(long pos, int length) throws SQLException {
if (pos < 1) {
throw new SQLException("position must be >= 1");
}
if (length < 0) {
throw new SQLException("length must be > 0");
}
String val = toString();
return val.substring((int) pos - 1, Math.min((int) pos - 1 + length, val.length()));
}
public Reader getCharacterStream() {
return new StringReader(toString());
}
/**
* Returns a Reader object that contains a partial Clob value, starting with the character
* specified by pos, which is length characters in length.
*
* @param pos the offset to the first character of the partial value to be retrieved. The first
* character in the Clob is at position 1.
* @param length the length in characters of the partial value to be retrieved.
* @return Reader through which the partial Clob value can be read.
* @throws SQLException if pos is less than 1 or if pos is greater than the number of characters
* in the Clob or if pos + length is greater than the number of characters in the Clob
*/
public Reader getCharacterStream(long pos, long length) throws SQLException {
String val = toString();
if (val.length() < (int) pos - 1 + length) {
throw new SQLException("pos + length is greater than the number of characters in the Clob");
}
String sub = val.substring((int) pos - 1, (int) pos - 1 + (int) length);
return new StringReader(sub);
}
/**
* Set character stream.
*
* @param pos position
* @return writer
* @throws SQLException if position is invalid
*/
public Writer setCharacterStream(long pos) throws SQLException {
int bytePosition = utf8Position((int) pos - 1);
OutputStream stream = setBinaryStream(bytePosition + 1);
return new OutputStreamWriter(stream, StandardCharsets.UTF_8);
}
public InputStream getAsciiStream() throws SQLException {
return getBinaryStream();
}
public long position(String searchStr, long start) {
return toString().indexOf(searchStr, (int) start - 1) + 1;
}
public long position(Clob searchStr, long start) {
return position(searchStr.toString(), start);
}
/**
* Convert character position into byte position in UTF8 byte array.
*
* @param charPosition charPosition
* @return byte position
*/
private int utf8Position(int charPosition) {
int pos = offset;
for (int i = 0; i < charPosition; i++) {
int byteValue = data[pos] & 0xff;
if (byteValue < 0x80) {
pos += 1;
} else if (byteValue < 0xE0) {
pos += 2;
} else if (byteValue < 0xF0) {
pos += 3;
} else {
pos += 4;
}
}
return pos;
}
/**
* Set String.
*
* @param pos position
* @param str string
* @return string length
* @throws SQLException if UTF-8 conversion failed
*/
public int setString(long pos, String str) throws SQLException {
if (str == null) {
throw new SQLException("cannot add null string");
}
if (pos < 0) {
throw new SQLException("position must be >= 0");
}
int bytePosition = utf8Position((int) pos - 1);
super.setBytes(bytePosition + 1 - offset, str.getBytes(StandardCharsets.UTF_8));
return str.length();
}
public int setString(long pos, String str, int offset, int len) throws SQLException {
if (str == null) {
throw new SQLException("cannot add null string");
}
if (offset < 0) {
throw new SQLException("offset must be >= 0");
}
if (len < 0) {
throw new SQLException("len must be > 0");
}
return setString(pos, str.substring(offset, Math.min(offset + len, str.length())));
}
public OutputStream setAsciiStream(long pos) throws SQLException {
return setBinaryStream(utf8Position((int) pos - 1) + 1);
}
/** Return character length of the Clob. Assume UTF8 encoding. */
@Override
public long length() {
// The length of a character string is the number of UTF-16 units (not the number of characters)
long len = 0;
int pos = offset;
// set ASCII (<= 127 chars)
while (len < length && data[pos] > 0) {
len++;
pos++;
}
// multi-bytes UTF-8
while (pos < offset + length) {
byte firstByte = data[pos++];
if (firstByte < 0) {
if (firstByte >> 5 != -2 || (firstByte & 30) == 0) {
if (firstByte >> 4 == -2) {
if (pos + 1 < offset + length) {
pos += 2;
len++;
} else {
throw new UncheckedIOException("invalid UTF8", new CharacterCodingException());
}
} else if (firstByte >> 3 != -2) {
throw new UncheckedIOException("invalid UTF8", new CharacterCodingException());
} else if (pos + 2 < offset + length) {
pos += 3;
len += 2;
} else {
// bad truncated UTF8
pos += offset + length;
len += 1;
}
} else {
pos++;
len++;
}
} else {
len++;
}
}
return len;
}
@Override
public void truncate(final long truncateLen) {
// truncate the number of UTF-16 characters
// this can result in a bad UTF-8 string if string finish with a
// character represented in 2 UTF-16
long len = 0;
int pos = offset;
// set ASCII (<= 127 chars)
while (len < length && len < truncateLen && data[pos] >= 0) {
len++;
pos++;
}
// multi-bytes UTF-8
while (pos < offset + length && len < truncateLen) {
byte firstByte = data[pos++];
if (firstByte < 0) {
if (firstByte >> 5 != -2 || (firstByte & 30) == 0) {
if (firstByte >> 4 == -2) {
if (pos + 1 < offset + length) {
pos += 2;
len++;
} else {
throw new UncheckedIOException("invalid UTF8", new CharacterCodingException());
}
} else if (firstByte >> 3 != -2) {
throw new UncheckedIOException("invalid UTF8", new CharacterCodingException());
} else if (pos + 2 < offset + length) {
if (len + 2 <= truncateLen) {
pos += 3;
len += 2;
} else {
// truncation will result in bad UTF-8 String
pos += 1;
len = truncateLen;
}
} else {
throw new UncheckedIOException("invalid UTF8", new CharacterCodingException());
}
} else {
pos++;
len++;
}
} else {
len++;
}
}
length = pos - offset;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
MariaDbClob that = (MariaDbClob) o;
if (length != that.length) return false;
for (int i = 0; i < length; i++) {
if (data[offset + i] != that.data[that.offset + i]) return false;
}
return true;
}
}