Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.jdbc.LOBFile

Modifier and Type	Field and Description
private final StorageRandomAccessFile	randomAccessFile An object giving random access to `storageFile`.
private final StorageFile	storageFile The temporary file where the contents of the LOB should be stored.

Access	Constructor and Description
pack-priv	LOBFile(StorageFile StorageFile object for which the file will be created lobFile) Constructs LOBFile.

Method Summary

Modifier and Type	Method and Description
pack-priv void	close() Closes the file.
pack-priv long	Returns: file pointer getFilePointer() Returns the current position of the file pointer.
pack-priv StorageFile	Returns: a `StorageFile` instance getStorageFile() Get the `StorageFile` which represents the file where the contents of the LOB are stored.
pack-priv long	Returns: length of the file length() Returns length of the file.
pack-priv int	Returns: number of bytes read read(byte[] buffer buff, int starting position of buffer off, int number of bytes len) Reads len number of bytes from the file starting from off position in the buffer.
pack-priv int	Returns: byte readByte() Reads one byte from file.
pack-priv void	seek(long new position pos) Sets the file pointer to a given position.
pack-priv void	setLength(long new size size) Sets the file length to a given size.
pack-priv void	write(int int value of the byte b) Writes one bytes into the file.
pack-priv void	write(byte[] byte array containing bytes to write into the file b, int starting position of segment off, int number of bytes to be written len) Writes a segment of bytes into the file.
pack-priv void	write(byte[] buffer to write buf) Writes a buffer completely into the file.

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

randomAccessFile	back to summary
private final StorageRandomAccessFile randomAccessFile An object giving random access to `storageFile`.

storageFile	back to summary
private final StorageFile storageFile The temporary file where the contents of the LOB should be stored.

LOBFile	back to summary
pack-priv LOBFile(StorageFile lobFile) throws FileNotFoundException Constructs LOBFile. Parameters lobFile:StorageFile StorageFile object for which the file will be created Exceptions FileNotFoundException: if the file exists but is a directory or cannot be opened

Method Detail

close	back to summary
pack-priv void close() throws IOException Closes the file. Exceptions IOException: if an I/O error occurs StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

back to summary

pack-priv void close() throws IOException

Closes the file.

Exceptions

IOException:: if an I/O error occurs
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

getFilePointer	back to summary
pack-priv long getFilePointer() throws IOException Returns the current position of the file pointer. Returns:long file pointer Exceptions IOException: if an I/O error occurs

getFilePointer

back to summary

pack-priv long getFilePointer() throws IOException

Returns the current position of the file pointer.

Returns:long

file pointer

Exceptions

IOException:: if an I/O error occurs

getStorageFile back to summary

getStorageFile	back to summary
pack-priv StorageFile getStorageFile() Get the `StorageFile` which represents the file where the contents of the LOB are stored. Returns:StorageFile a `StorageFile` instance

pack-priv StorageFile getStorageFile()

Get the StorageFile which represents the file where the contents of the LOB are stored.

Returns:StorageFile: a StorageFile instance

length	back to summary
pack-priv long length() throws IOException Returns length of the file. Returns:long length of the file Exceptions IOException: if an I/O error occurs

length

back to summary

pack-priv long length() throws IOException

Returns length of the file.

Returns:long

length of the file

Exceptions

IOException:: if an I/O error occurs

read	back to summary
pack-priv int read(byte[] buff, int off, int len) throws IOException, StandardException Reads len number of bytes from the file starting from off position in the buffer. Parameters buff:byte[] buffer off:int starting position of buffer len:int number of bytes Returns:int number of bytes read Exceptions IOException: if an I/O error occurs StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

read

back to summary

pack-priv int read(byte[] buff, int off, int len) throws IOException, StandardException

Reads len number of bytes from the file starting from off position in the buffer.

Parameters

buff:byte[]: buffer
off:int: starting position of buffer
len:int: number of bytes

Returns:int

number of bytes read

Exceptions

IOException:: if an I/O error occurs
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

readByte	back to summary
pack-priv int readByte() throws IOException, StandardException Reads one byte from file. Returns:int byte Exceptions IOException: if disk operation fails StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

readByte

back to summary

pack-priv int readByte() throws IOException, StandardException

Reads one byte from file.

Returns:int

byte

Exceptions

IOException:: if disk operation fails
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

seek	back to summary
pack-priv void seek(long pos) throws IOException Sets the file pointer to a given position. Parameters pos:long new position Exceptions IOException: if an I/O error occurs

seek

back to summary

pack-priv void seek(long pos) throws IOException

Sets the file pointer to a given position.

Parameters

pos:long: new position

Exceptions

IOException:: if an I/O error occurs

setLength	back to summary
pack-priv void setLength(long size) throws IOException, StandardException Sets the file length to a given size. Parameters size:long new size Exceptions IOException: if an I/O error occurs StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

setLength

back to summary

pack-priv void setLength(long size) throws IOException, StandardException

Sets the file length to a given size.

Parameters

size:long: new size

Exceptions

IOException:: if an I/O error occurs
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

write	back to summary
pack-priv void write(int b) throws IOException, StandardException Writes one bytes into the file. Parameters b:int int value of the byte Exceptions IOException: if an I/O error occurs StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

write

back to summary

pack-priv void write(int b) throws IOException, StandardException

Writes one bytes into the file.

Parameters

b:int: int value of the byte

Exceptions

IOException:: if an I/O error occurs
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

write	back to summary
pack-priv void write(byte[] b, int off, int len) throws IOException, StandardException Writes a segment of bytes into the file. Parameters b:byte[] byte array containing bytes to write into the file off:int starting position of segment len:int number of bytes to be written Exceptions IOException: if an I/O error occurs StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

write

back to summary

pack-priv void write(byte[] b, int off, int len) throws IOException, StandardException

Writes a segment of bytes into the file.

Parameters

b:byte[]: byte array containing bytes to write into the file
off:int: starting position of segment
len:int: number of bytes to be written

Exceptions

IOException:: if an I/O error occurs
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

write	back to summary
pack-priv void write(byte[] buf) throws IOException, StandardException Writes a buffer completely into the file. Parameters buf:byte[] buffer to write Exceptions IOException: if an I/O error occurs StandardException: it won't be thrown, it's in signature to allow subclasses to throw StandardException

write

back to summary

pack-priv void write(byte[] buf) throws IOException, StandardException

Writes a buffer completely into the file.

Parameters

buf:byte[]: buffer to write

Exceptions

IOException:: if an I/O error occurs
StandardException:: it won't be thrown, it's in signature to allow subclasses to throw StandardException

pack-priv Class LOBFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail