This class uses buffering while reading from a BFILE. The simple constructor (the one that takes just a BFILE) uses a default buffer size that should be sufficient for most streams; however, users can specify any buffer size using an alternate constructor.
In order to to use the JAI stream objects, you will need to include the following import statements in your Java file:
import java.sql.Blob;
import oracle.sql.BFILE;
In order to use JAI with Oracle Multimedia JAI stream objects, you will also need to import classes from the oracle.ord.media.jai.io package into your Java file.
Before running the methods associated with the BfileInputStream object, the following operations must have already been performed:
import javax.media.jai.JAI;
import java.awt.image.RenderedImage;
public class BfileInputStream extends com.sun.media.jai.codec.SeekableStream implements SeekableInputStream
Constructor and Description |
---|
BfileInputStream(oracle.sql.BFILE bfile)
Deprecated.
Creates a BfileInputStream object that reads from the specified BFILE. The constructor uses the maximum chunk size defined for a BFILE. The BFILE will be opened after this constructor.
|
BfileInputStream(oracle.sql.BFILE bfile, int chunkSize)
Deprecated.
Creates a BfileInputStream object that reads from the specified BFILE. The constructor uses the specified chunk size. The BFILE will be opened after this constructor executes.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canSeekBackwards()
Deprecated.
Checks whether or not the stream can seek backward. Because the BfileInputStream object can seek backward, this method will always return
true . |
void |
close()
Deprecated.
Closes the BfileInputStream object, releasing any resources being used. The BFILE automatically closes after the stream closes.
|
oracle.sql.BFILE |
getBFILE()
Deprecated.
Returns the BFILE associated with the BfileInputStream object.
|
java.lang.String |
getDBErrorMessage()
Deprecated.
Returns the database error message associated with the last error encountered.
|
long |
getFilePointer()
Deprecated.
Returns the offset from the beginning of the BFILE at which the next read operation will occur.
|
boolean |
hasDBErrorMessage()
Deprecated.
Checks whether or not a database error message has been set.
|
void |
mark(int readLimit)
Deprecated.
Marks the current position in the BfileInputStream object. A call to the
reset() method will return you to the last marked position in the BfileInputStream object. |
boolean |
markSupported()
Deprecated.
Checks whether or not the BfileInputStream object supports marking. Because the BfileInputStream object supports marking, this method will always return
true . |
int |
read()
Deprecated.
Reads a single byte from the BFILE associated with the BfileInputStream object.
|
int |
read(byte[] b)
Deprecated.
Reads data from the BFILE into the specified buffer.
|
int |
read(byte[] b, int off, int len)
Deprecated.
Reads up to the specified length of bytes of data from the BFILE into the specified buffer, starting from the specified offset.
|
long |
remaining()
Deprecated.
Returns the number of unread bytes remaining in the BFILE.
|
void |
reset()
Deprecated.
Repositions the stream to the position of the last valid mark.
|
void |
seek(long pos)
Deprecated.
Sets the offset from the beginning of the BFILE at which the next read operation will occur.
|
long |
skip(long n)
Deprecated.
Attempts to skip over the specified number of bytes in the BFILE.
The number of bytes skipped may be smaller than the specified number; for example, the number would be smaller if the end of the file is reached. |
readBoolean, readByte, readChar, readCharLE, readDouble, readDoubleLE, readFloat, readFloatLE, readFully, readFully, readInt, readIntLE, readLine, readLong, readLongLE, readShort, readShortLE, readUnsignedByte, readUnsignedInt, readUnsignedIntLE, readUnsignedShort, readUnsignedShortLE, readUTF, skipBytes, wrapInputStream
public BfileInputStream(oracle.sql.BFILE bfile) throws java.io.IOException, java.sql.SQLException
bfile
- the BFILE from which data will be read.java.io.IOException
- if an IO exception occurs, or if the value of the bfile parameter is null
, or if the underlying file does not exist.java.sql.SQLException
- if a SQL exception occurs.public BfileInputStream(oracle.sql.BFILE bfile, int chunkSize) throws java.io.IOException, java.sql.SQLException
bfile
- the BFILE from which data will be read.chunkSize
- the maximum amount of data to read from the BFILE at one time.java.io.IOException
- if an IO exception occurs, or if the value of the bfile parameter is null
, or if the value of the chunkSize parameter is less than 1, or if the underlying file does not exist.java.sql.SQLException
- if a SQL exception occurs.public oracle.sql.BFILE getBFILE()
public long getFilePointer() throws java.io.IOException
SeekableInputStream
getFilePointer
in interface SeekableInputStream
getFilePointer
in class com.sun.media.jai.codec.SeekableStream
java.io.IOException
- if an IO error occurs.public int read() throws java.io.IOException
read
in interface SeekableInputStream
read
in class com.sun.media.jai.codec.SeekableStream
java.io.IOException
- if an IO error occurs.public int read(byte[] b) throws java.io.IOException
read
in interface SeekableInputStream
read
in class java.io.InputStream
b
- the buffer into which the data is read.java.io.IOException
- if an IO error occurs.public int read(byte[] b, int off, int len) throws java.io.IOException
read
in interface SeekableInputStream
read
in class com.sun.media.jai.codec.SeekableStream
b
- the buffer into which the data is read.off
- the offset from the beginning of the buffer at which data will be written, in bytes.len
- the maximum number of bytes to be read into the buffer.java.io.IOException
- if an IO error occurs.public void seek(long pos) throws java.io.IOException
seek
in interface SeekableInputStream
seek
in class com.sun.media.jai.codec.SeekableStream
pos
- the offset from the beginning of the BFILE at which the next read operation will occur.java.io.IOException
- if the value of the pos parameter is less than zero or an IO error occurs.public boolean canSeekBackwards()
true
.canSeekBackwards
in class com.sun.media.jai.codec.SeekableStream
true
.public void mark(int readLimit)
reset()
method will return you to the last marked position in the BfileInputStream object.mark
in class com.sun.media.jai.codec.SeekableStream
readLimit
- ignored by the class.public boolean markSupported()
true
.markSupported
in class com.sun.media.jai.codec.SeekableStream
true
.public void reset() throws java.io.IOException
reset
in class com.sun.media.jai.codec.SeekableStream
java.io.IOException
- if this stream has not been marked or the mark has been invalidated.public long skip(long n) throws java.io.IOException
The number of bytes skipped may be smaller than the specified number; for example, the number would be smaller if the end of the file is reached.
skip
in interface SeekableInputStream
skip
in class java.io.InputStream
n
- the number of bytes to be skipped.java.io.IOException
- if an IO error occurs.public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface SeekableInputStream
close
in class java.io.InputStream
java.io.IOException
- if an IO error occurs.public long remaining()
public java.lang.String getDBErrorMessage()
String
with the last database error message, or null
if no such message existed.public boolean hasDBErrorMessage()
true
if an exception has occurred while communicating with the database that returned a supplementary error message; false
otherwise.