com.day.io

Class RegionFileInputStream

java.lang.Object

java.io.InputStream

com.day.io.RegionFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class RegionFileInputStream
extends InputStream

RegionFileInputStream implements an input stream that streams the contents of a region of a file. The reading is buffered. The file is openend upon the first access. this helps minimizing the total number of open files.

Constructor Summary

Constructors

Constructor and Description
RegionFileInputStream(File file) Same as RegionFileInputStream(File, boolean) with inflate set to false.
RegionFileInputStream(File file, boolean inflate) Same as RegionFileInputStream(File, long, long, boolean) where offset is 0 and len the length of the file.
RegionFileInputStream(File file, long off, long len) Creates a new input stream that reads for the region [off, off+len] of the given file.
RegionFileInputStream(File file, long off, long len, boolean inflate) Creates a new input stream that reads for the region [off, off+len] of the given file.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
RegionFileInputStream	duplicate() Duplicates this stream.
long	getAbsolutePosition() Returns the read pointer position relative to this file.
File	getFile() Retruns the underlying file.
long	getPosition() Returns the read pointer position relative to this region.
long	getRemaining() Returns the remaining bytes available in this region
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
RegionFileInputStream	substream(long off, long len) Creates a new RegionFileInputStream that is based on this one.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegionFileInputStream

public RegionFileInputStream(File file)
                      throws IOException,
                             FileNotFoundException

Same as RegionFileInputStream(File, boolean) with inflate set to false.

Parameters:

file - the file to read from.

Throws:

FileNotFoundException - if the file was not found

IOException - if an I/O error occurs

RegionFileInputStream

public RegionFileInputStream(File file,
                             boolean inflate)
                      throws IOException,
                             FileNotFoundException

Same as RegionFileInputStream(File, long, long, boolean) where offset is 0 and len the length of the file.

Parameters:

file - the file to read from.

inflate - indicates if the file is compressed

Throws:

FileNotFoundException - if the file was not found

IOException - if an I/O error occurs

RegionFileInputStream

public RegionFileInputStream(File file,
                             long off,
                             long len)
                      throws IOException,
                             FileNotFoundException

Creates a new input stream that reads for the region [off, off+len] of the given file. If the region is greater than the length of the file an IOException os thrown.

Parameters:

file - the file to read from.

off - the absolute offset in the file to read from

len - the total length of the region

Throws:

FileNotFoundException - if the file was not found

IOException - if an I/O error occurs

RegionFileInputStream

public RegionFileInputStream(File file,
                             long off,
                             long len,
                             boolean inflate)
                      throws FileNotFoundException,
                             IOException

Creates a new input stream that reads for the region [off, off+len] of the given file. If the region is greater than the length of the file an IOException os thrown.

Parameters:

file - the file to read from.

off - the absolute offset in the file to read from

len - the total length of the region

inflate - indicates if the file is compressed

Throws:

FileNotFoundException - if the file was not found

IOException - if an I/O error occurs

Method Detail

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

getFile

public File getFile()

Retruns the underlying file.

Returns:

the underlying file.

getAbsolutePosition

public long getAbsolutePosition()
                         throws IOException

Returns the read pointer position relative to this file.

Returns:

the read pointer position relative to this fille.

Throws:

IOException - if an I/O error occurs.

getPosition

public long getPosition()
                 throws IOException

Returns the read pointer position relative to this region.

Returns:

the read pointer position relative to this region.

Throws:

IOException - if an I/O error occurs.

getRemaining

public long getRemaining()
                  throws IOException

Returns the remaining bytes available in this region

Returns:

the remaining bytes available in this region

Throws:

IOException - if an I/O error occurs.

substream

public RegionFileInputStream substream(long off,
                                       long len)
                                throws IOException

Creates a new RegionFileInputStream that is based on this one.

Parameters:

off - relative offset to the current read pointer of this region

len - total length of this new stream.

Returns:

the new region streem

Throws:

IOException - if an I/O error occurs.

duplicate

public RegionFileInputStream duplicate()
                                throws IOException

Duplicates this stream. If the stream is already consumed or compressed, null is returned.

Returns:

a duplicate of this stream or null

Throws:

IOException - if an I/O error occurs.