MySQL Connector/J 9.2.0 · com.mysql.cj.jdbc.Blob · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private byte[]	binaryData The binary data that makes up this BLOB
private ExceptionInterceptor	exceptionInterceptor
private boolean	isClosed
private final Lock	lock

Access	Constructor and Description
pack-priv	Blob(ExceptionInterceptor exception interceptor exceptionInterceptor) Creates a Blob without data
public	Blob(byte[] data to fill the Blob data, ExceptionInterceptor exception interceptor exceptionInterceptor) Creates a BLOB encapsulating the given binary data
pack-priv	Blob(byte[] data to fill the Blob data, ResultSetInternalMethods result set creatorResultSetToSet, int column index columnIndexToSet) Creates an updatable BLOB that can update in-place (not implemented yet).

Method Summary

Modifier and Type	Method and Description
private void	checkClosed()
public void	free() Implements java.sql.Blob.free. This method frees the `Blob` object and releases the resources that it holds.
private byte[]	getBinaryData()
public InputStream	getBinaryStream() Implements java.sql.Blob.getBinaryStream. Retrieves the `BLOB` value designated by this `Blob` instance as a stream.
public InputStream	getBinaryStream(long the offset to the first byte of the partial value to be retrieved. The first byte in the `Blob` is at position 1. pos, long the length in bytes of the partial value to be retrieved length) Implements java.sql.Blob.getBinaryStream. Returns an `InputStream` object that contains a partial `Blob` value, starting with the byte specified by pos, which is length bytes in length.
public byte[]	getBytes(long the ordinal position of the first byte in the `BLOB` value to be extracted; the first byte is at position 1 pos, int the number of consecutive bytes to be copied; the value for length must be 0 or greater length) Implements java.sql.Blob.getBytes. Retrieves all or part of the `BLOB` value that this `Blob` object represents, as an array of bytes.
public long	length() Implements java.sql.Blob.length. Returns the number of bytes in the `BLOB` value designated by this `Blob` object.
public long	position(byte[] the byte array for which to search pattern, long the position at which to begin searching; the first position is 1 start) Implements java.sql.Blob.position. Retrieves the byte position at which the specified byte array `pattern` begins within the `BLOB` value that this `Blob` object represents.
public long	position(Blob the `Blob` object designating the `BLOB` value for which to search pattern, long the position in the `BLOB` value at which to begin searching; the first position is 1 start) Implements java.sql.Blob.position. Retrieves the byte position in the `BLOB` value designated by this `Blob` object at which `pattern` begins.
private void	setBinaryData(byte[] newBinaryData)
public OutputStream	setBinaryStream(long the position in the `BLOB` value at which to start writing; the first position is 1 indexToWriteAt) Implements java.sql.Blob.setBinaryStream. Retrieves a stream that can be used to write to the `BLOB` value that this `Blob` object represents.
public int	setBytes(long the position in the `BLOB` object at which to start writing; the first position is 1 writeAt, byte[] the array of bytes to be written to the `BLOB` value that this `Blob` object represents bytes) Implements java.sql.Blob.setBytes. Writes the given array of bytes to the `BLOB` value that this `Blob` object represents, starting at position `pos`, and returns the number of bytes written.
public int	setBytes(long the position in the `BLOB` object at which to start writing; the first position is 1 writeAt, byte[] the array of bytes to be written to this `BLOB` object bytes, int the offset into the array `bytes` at which to start reading the bytes to be set offset, int the number of bytes to be written to the `BLOB` value from the array of bytes `bytes` length) Implements java.sql.Blob.setBytes. Writes all or part of the given `byte` array to the `BLOB` value that this `Blob` object represents and returns the number of bytes written.
public void	streamClosed(byte[] byteData)
public void	streamClosed(WatchableStream `WatchableStream` out) Implements com.mysql.cj.protocol.OutputStreamWatcher.streamClosed. Called when the OutputStream being watched has .close() called
public void	truncate(long the length, in bytes, to which the `BLOB` value that this `Blob` object represents should be truncated len) Implements java.sql.Blob.truncate. Truncates the `BLOB` value that this `Blob` object represents to be `len` bytes in length.

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

binaryData	back to summary
private byte[] binaryData The binary data that makes up this BLOB

exceptionInterceptor	back to summary
private ExceptionInterceptor exceptionInterceptor

isClosed	back to summary
private boolean isClosed

lock	back to summary
private final Lock lock

Blob	back to summary
pack-priv Blob(ExceptionInterceptor exceptionInterceptor) Creates a Blob without data Parameters exceptionInterceptor:ExceptionInterceptor exception interceptor

Blob	back to summary
public Blob(byte[] data, ExceptionInterceptor exceptionInterceptor) Creates a BLOB encapsulating the given binary data Parameters data:byte[] data to fill the Blob exceptionInterceptor:ExceptionInterceptor exception interceptor

Blob	back to summary
pack-priv Blob(byte[] data, ResultSetInternalMethods creatorResultSetToSet, int columnIndexToSet) Creates an updatable BLOB that can update in-place (not implemented yet). Parameters data:byte[] data to fill the Blob creatorResultSetToSet:ResultSetInternalMethods result set columnIndexToSet:int column index

Method Detail

checkClosed	back to summary
private void checkClosed() throws SQLException

free back to summary

free	back to summary
public void free() throws SQLException Implements java.sql.Blob.free. Doc from java.sql.Blob.free. This method frees the `Blob` object and releases the resources that it holds. The object is invalid once the `free` method is called. After `free` has been called, any attempt to invoke a method other than `free` will result in an `SQLException` being thrown. If `free` is called multiple times, the subsequent calls to `free` are treated as a no-op. Annotations @Override Exceptions SQLException: if an error occurs releasing the Blob's resources

public void free() throws SQLException

Implements java.sql.Blob.free.

Doc from java.sql.Blob.free.

This method frees the Blob object and releases the resources that it holds. The object is invalid once the free method is called.

After free has been called, any attempt to invoke a method other than free will result in an SQLException being thrown. If free is called multiple times, the subsequent calls to free are treated as a no-op.

Annotations

@Override

Exceptions

SQLException:: if an error occurs releasing the Blob's resources

getBinaryData	back to summary
private byte[] getBinaryData()

getBinaryStream back to summary

getBinaryStream	back to summary
public InputStream getBinaryStream() throws SQLException Implements java.sql.Blob.getBinaryStream. Doc from java.sql.Blob.getBinaryStream. Retrieves the `BLOB` value designated by this `Blob` instance as a stream. Returns:InputStream a stream containing the `BLOB` data Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value

public InputStream getBinaryStream() throws SQLException

Implements java.sql.Blob.getBinaryStream.

Doc from java.sql.Blob.getBinaryStream.

Retrieves the BLOB value designated by this Blob instance as a stream.

Returns:InputStream

a stream containing the BLOB data

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value

getBinaryStream back to summary

getBinaryStream	back to summary
public InputStream getBinaryStream(long pos, long length) throws SQLException Implements java.sql.Blob.getBinaryStream. Doc from java.sql.Blob.getBinaryStream. Returns an `InputStream` object that contains a partial `Blob` value, starting with the byte specified by pos, which is length bytes in length. Parameters pos:long the offset to the first byte of the partial value to be retrieved. The first byte in the `Blob` is at position 1. length:long the length in bytes of the partial value to be retrieved Returns:InputStream `InputStream` through which the partial `Blob` value can be read. Annotations @Override Exceptions SQLException: if pos is less than 1 or if pos is greater than the number of bytes in the `Blob` or if pos + length is greater than the number of bytes in the `Blob`

public InputStream getBinaryStream(long pos, long length) throws SQLException

Implements java.sql.Blob.getBinaryStream.

Doc from java.sql.Blob.getBinaryStream.

Returns an InputStream object that contains a partial Blob value, starting with the byte specified by pos, which is length bytes in length.

Parameters

pos:long: the offset to the first byte of the partial value to be retrieved. The first byte in the Blob is at position 1.
length:long: the length in bytes of the partial value to be retrieved

Returns:InputStream

InputStream through which the partial Blob value can be read.

Annotations

@Override

Exceptions

SQLException:: if pos is less than 1 or if pos is greater than the number of bytes in the Blob or if pos + length is greater than the number of bytes in the Blob

getBytes back to summary

getBytes	back to summary
public byte[] getBytes(long pos, int length) throws SQLException Implements java.sql.Blob.getBytes. Doc from java.sql.Blob.getBytes. Retrieves all or part of the `BLOB` value that this `Blob` object represents, as an array of bytes. This `byte` array contains up to `length` consecutive bytes starting at position `pos`. Parameters pos:long the ordinal position of the first byte in the `BLOB` value to be extracted; the first byte is at position 1 length:int the number of consecutive bytes to be copied; the value for length must be 0 or greater Returns:byte[] a byte array containing up to `length` consecutive bytes from the `BLOB` value designated by this `Blob` object, starting with the byte at position `pos` Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value; if pos is less than 1 or length is less than 0

public byte[] getBytes(long pos, int length) throws SQLException

Implements java.sql.Blob.getBytes.

Doc from java.sql.Blob.getBytes.

Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes. This byte array contains up to length consecutive bytes starting at position pos.

Parameters

pos:long: the ordinal position of the first byte in the BLOB value to be extracted; the first byte is at position 1
length:int: the number of consecutive bytes to be copied; the value for length must be 0 or greater

Returns:byte[]

a byte array containing up to length consecutive bytes from the BLOB value designated by this Blob object, starting with the byte at position pos

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value; if pos is less than 1 or length is less than 0

length back to summary

length	back to summary
public long length() throws SQLException Implements java.sql.Blob.length. Doc from java.sql.Blob.length. Returns the number of bytes in the `BLOB` value designated by this `Blob` object. Returns:long length of the `BLOB` in bytes Annotations @Override Exceptions SQLException: if there is an error accessing the length of the `BLOB`

public long length() throws SQLException

Implements java.sql.Blob.length.

Doc from java.sql.Blob.length.

Returns the number of bytes in the BLOB value designated by this Blob object.

Returns:long

length of the BLOB in bytes

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the length of the BLOB

position back to summary

position	back to summary
public long position(byte[] pattern, long start) throws SQLException Implements java.sql.Blob.position. Doc from java.sql.Blob.position. Retrieves the byte position at which the specified byte array `pattern` begins within the `BLOB` value that this `Blob` object represents. The search for `pattern` begins at position `start`. Parameters pattern:byte[] the byte array for which to search start:long the position at which to begin searching; the first position is 1 Returns:long the position at which the pattern appears, else -1 Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` or if start is less than 1

public long position(byte[] pattern, long start) throws SQLException

Implements java.sql.Blob.position.

Doc from java.sql.Blob.position.

Retrieves the byte position at which the specified byte array pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start.

Parameters

pattern:byte[]: the byte array for which to search
start:long: the position at which to begin searching; the first position is 1

Returns:long

the position at which the pattern appears, else -1

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB or if start is less than 1

position back to summary

position	back to summary
public long position(Blob pattern, long start) throws SQLException Implements java.sql.Blob.position. Doc from java.sql.Blob.position. Retrieves the byte position in the `BLOB` value designated by this `Blob` object at which `pattern` begins. The search begins at position `start`. Parameters pattern:Blob the `Blob` object designating the `BLOB` value for which to search start:long the position in the `BLOB` value at which to begin searching; the first position is 1 Returns:long the position at which the pattern begins, else -1 Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value or if start is less than 1

public long position(Blob pattern, long start) throws SQLException

Implements java.sql.Blob.position.

Doc from java.sql.Blob.position.

Retrieves the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start.

Parameters

pattern:Blob: the Blob object designating the BLOB value for which to search
start:long: the position in the BLOB value at which to begin searching; the first position is 1

Returns:long

the position at which the pattern begins, else -1

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value or if start is less than 1

setBinaryData	back to summary
private void setBinaryData(byte[] newBinaryData)

setBinaryStream back to summary

setBinaryStream	back to summary
public OutputStream setBinaryStream(long indexToWriteAt) throws SQLException Implements java.sql.Blob.setBinaryStream. Doc from java.sql.Blob.setBinaryStream. Retrieves a stream that can be used to write to the `BLOB` value that this `Blob` object represents. The stream begins at position `pos`. The bytes written to the stream will overwrite the existing bytes in the `Blob` object starting at the position `pos`. If the end of the `Blob` value is reached while writing to the stream, then the length of the `Blob` value will be increased to accommodate the extra bytes. Note If the value specified for `pos` is greater than the length+1 of the `BLOB` value then the behavior is undefined. Some JDBC drivers may throw an `SQLException` while other drivers may support this operation. Parameters indexToWriteAt:long the position in the `BLOB` value at which to start writing; the first position is 1 Returns:OutputStream a `java.io.OutputStream` object to which data can be written Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value or if pos is less than 1

public OutputStream setBinaryStream(long indexToWriteAt) throws SQLException

Implements java.sql.Blob.setBinaryStream.

Doc from java.sql.Blob.setBinaryStream.

Retrieves a stream that can be used to write to the BLOB value that this Blob object represents. The stream begins at position pos. The bytes written to the stream will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing to the stream, then the length of the Blob value will be increased to accommodate the extra bytes.

Note

If the value specified for pos is greater than the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw an SQLException while other drivers may support this operation.

Parameters

indexToWriteAt:long: the position in the BLOB value at which to start writing; the first position is 1

Returns:OutputStream

a java.io.OutputStream object to which data can be written

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value or if pos is less than 1

setBytes back to summary

setBytes	back to summary
public int setBytes(long writeAt, byte[] bytes) throws SQLException Implements java.sql.Blob.setBytes. Doc from java.sql.Blob.setBytes. Writes the given array of bytes to the `BLOB` value that this `Blob` object represents, starting at position `pos`, and returns the number of bytes written. The array of bytes will overwrite the existing bytes in the `Blob` object starting at the position `pos`. If the end of the `Blob` value is reached while writing the array of bytes, then the length of the `Blob` value will be increased to accommodate the extra bytes. Note If the value specified for `pos` is greater than the length+1 of the `BLOB` value then the behavior is undefined. Some JDBC drivers may throw an `SQLException` while other drivers may support this operation. Parameters writeAt:long the position in the `BLOB` object at which to start writing; the first position is 1 bytes:byte[] the array of bytes to be written to the `BLOB` value that this `Blob` object represents Returns:int the number of bytes written Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value or if pos is less than 1

public int setBytes(long writeAt, byte[] bytes) throws SQLException

Implements java.sql.Blob.setBytes.

Doc from java.sql.Blob.setBytes.

Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accommodate the extra bytes.

Note

Parameters

writeAt:long: the position in the BLOB object at which to start writing; the first position is 1
bytes:byte[]: the array of bytes to be written to the BLOB value that this Blob object represents

Returns:int

the number of bytes written

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value or if pos is less than 1

setBytes back to summary

setBytes	back to summary
public int setBytes(long writeAt, byte[] bytes, int offset, int length) throws SQLException Implements java.sql.Blob.setBytes. Doc from java.sql.Blob.setBytes. Writes all or part of the given `byte` array to the `BLOB` value that this `Blob` object represents and returns the number of bytes written. Writing starts at position `pos` in the `BLOB` value; `len` bytes from the given byte array are written. The array of bytes will overwrite the existing bytes in the `Blob` object starting at the position `pos`. If the end of the `Blob` value is reached while writing the array of bytes, then the length of the `Blob` value will be increased to accommodate the extra bytes. Note If the value specified for `pos` is greater than the length+1 of the `BLOB` value then the behavior is undefined. Some JDBC drivers may throw an `SQLException` while other drivers may support this operation. Parameters writeAt:long the position in the `BLOB` object at which to start writing; the first position is 1 bytes:byte[] the array of bytes to be written to this `BLOB` object offset:int the offset into the array `bytes` at which to start reading the bytes to be set length:int the number of bytes to be written to the `BLOB` value from the array of bytes `bytes` Returns:int the number of bytes written Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value or if pos is less than 1

public int setBytes(long writeAt, byte[] bytes, int offset, int length) throws SQLException

Implements java.sql.Blob.setBytes.

Doc from java.sql.Blob.setBytes.

Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written. Writing starts at position pos in the BLOB value; len bytes from the given byte array are written. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accommodate the extra bytes.

Note

Parameters

writeAt:long: the position in the BLOB object at which to start writing; the first position is 1
bytes:byte[]: the array of bytes to be written to this BLOB object
offset:int: the offset into the array bytes at which to start reading the bytes to be set
length:int: the number of bytes to be written to the BLOB value from the array of bytes bytes

Returns:int

the number of bytes written

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value or if pos is less than 1

streamClosed	back to summary
public void streamClosed(byte[] byteData)

streamClosed back to summary

streamClosed	back to summary
public void streamClosed(WatchableStream out) Implements com.mysql.cj.protocol.OutputStreamWatcher.streamClosed. Doc from com.mysql.cj.protocol.OutputStreamWatcher.streamClosed. Called when the OutputStream being watched has .close() called Parameters out:WatchableStream `WatchableStream` Annotations @Override

public void streamClosed(WatchableStream out)

Implements com.mysql.cj.protocol.OutputStreamWatcher.streamClosed.

Doc from com.mysql.cj.protocol.OutputStreamWatcher.streamClosed.

Called when the OutputStream being watched has .close() called

Parameters

out:WatchableStream: WatchableStream

Annotations

@Override

truncate back to summary

truncate	back to summary
public void truncate(long len) throws SQLException Implements java.sql.Blob.truncate. Doc from java.sql.Blob.truncate. Truncates the `BLOB` value that this `Blob` object represents to be `len` bytes in length. Note If the value specified for `pos` is greater than the length+1 of the `BLOB` value then the behavior is undefined. Some JDBC drivers may throw an `SQLException` while other drivers may support this operation. Parameters len:long the length, in bytes, to which the `BLOB` value that this `Blob` object represents should be truncated Annotations @Override Exceptions SQLException: if there is an error accessing the `BLOB` value or if len is less than 0

public void truncate(long len) throws SQLException

Implements java.sql.Blob.truncate.

Doc from java.sql.Blob.truncate.

Truncates the BLOB value that this Blob object represents to be len bytes in length.

Note

Parameters

len:long: the length, in bytes, to which the BLOB value that this Blob object represents should be truncated

Annotations

@Override

Exceptions

SQLException:: if there is an error accessing the BLOB value or if len is less than 0

public Class Blob

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail