ImportFileInputStream (Apache Derby V10.14 Internals)

java.lang.Object
- java.io.InputStream
- - org.apache.derby.impl.load.ImportFileInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
class ImportFileInputStream
extends java.io.InputStream
```
An InputStream, which can stream data from a file, starting from any offset in the file. This stream operates on top of a RandomAccessFile object. This class overrides InputStream methods to read from the given RandomAccessFile and provides an addtional method seek(..) to position the stream at offset in the file.

Field Summary

Fields
Modifier and Type Field Description

private long currentPosition

private long fileLength

private java.io.RandomAccessFile raf

Fields
Modifier and Type	Field	Description
`private long`	`currentPosition`
`private long`	`fileLength`
`private java.io.RandomAccessFile`	`raf`

Constructor Summary

Constructors
Constructor Description

ImportFileInputStream(java.io.RandomAccessFile raf)
Create a ImportFileInputStream object for the given file.

Constructors
Constructor	Description
`ImportFileInputStream(java.io.RandomAccessFile raf)`	Create a `ImportFileInputStream` object for the given file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`available()`	Returns the number of bytes that can be read from this stream.
`void`	`close()`	Closes this input stream and releases any associated resources
`int`	`read()`	Reads a byte of data from this input stream.
`int`	`read(byte[] buf, int offset, int length)`	Reads up to `length` bytes of data from this input stream into given array.
`(package private) void`	`seek(long offset)`	Sets the file offset at which the next read will occur.

Methods inherited from class java.io.InputStream
mark, markSupported, read, readAllBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - raf
```
private java.io.RandomAccessFile raf
```
  - currentPosition
```
private long currentPosition
```
  - fileLength
```
private long fileLength
```
- Constructor Detail
  - ImportFileInputStream
```
ImportFileInputStream(java.io.RandomAccessFile raf)
               throws java.io.IOException
```
    Create a ImportFileInputStream object for the given file.
    
    Parameters:
    
    raf - file the stream reads from.
    
    Throws:
    
    java.io.IOException - if any I/O error occurs.
- Method Detail
  - seek
```
void seek(long offset)
   throws java.io.IOException
```
    Sets the file offset at which the next read will occur.
    
    Parameters:
    
    offset - byte offset in the file.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - read
```
public int read()
         throws java.io.IOException
```
    Reads a byte of data from this input stream.
    
    Specified by:
    
    read in class java.io.InputStream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - read
```
public int read(byte[] buf,
                int offset,
                int length)
         throws java.io.IOException
```
    Reads up to length bytes of data from this input stream into given array. This method blocks until some input is available.
    
    Overrides:
    
    read in class java.io.InputStream
    
    Parameters:
    
    buf - the buffer into which the data is read.
    
    offset - the start offset of the data.
    
    length - the maximum number of bytes read.
    
    Returns:
    
    the total number of bytes read into the buffer, or -1 if there is no more data because the end of the file has been reached.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - available
```
public int available()
              throws java.io.IOException
```
    Returns the number of bytes that can be read from this stream.
    
    Overrides:
    
    available in class java.io.InputStream
    
    Returns:
    
    the number of bytes that can be read from this stream.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - close
```
public void close()
           throws java.io.IOException
```
    Closes this input stream and releases any associated resources
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Overrides:
    
    close in class java.io.InputStream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.

Class ImportFileInputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Field Detail

raf

currentPosition

fileLength

Constructor Detail

ImportFileInputStream

Method Detail

seek

read

read

available

close