org.eclipse.osgi.framework.internal.reliablefile

Class ReliableFileInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.eclipse.osgi.framework.internal.reliablefile.ReliableFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ReliableFileInputStream
extends FilterInputStream

A ReliableFile FileInputStream replacement class. This class can be used just like FileInputStream. The class is in partnership with ReliableFileOutputStream to avoid losing file data by using multiple files.

See Also:

ReliableFileOutputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
ReliableFileInputStream(File file) Constructs a new ReliableFileInputStream on the File file.
ReliableFileInputStream(File file, int generation, int openMask) Constructs a new ReliableFileInputStream on the File file.
ReliableFileInputStream(String name) Constructs a new ReliableFileInputStream on the file named name.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Override default available method.
void	close() Closes this input stream and releases any system resources associated with the stream.
void	mark(int readlimit) Override default mark method.
boolean	markSupported() Override default markSupported method.
int	read() Override default FilterInputStream method.
int	read(byte[] b) Override default FilterInputStream method.
int	read(byte[] b, int off, int len) Override default FilterInputStream method.
void	reset() Override default reset method.
long	skip(long n) Override default skip method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReliableFileInputStream

public ReliableFileInputStream(String name)
                        throws IOException

Constructs a new ReliableFileInputStream on the file named name. If the file does not exist, the FileNotFoundException is thrown. The name may be absolute or relative to the System property "user.dir".

Parameters:

name - the file on which to stream reads.

Throws:

IOException - If an error occurs opening the file.

ReliableFileInputStream

public ReliableFileInputStream(File file)
                        throws IOException

Constructs a new ReliableFileInputStream on the File file. If the file does not exist, the FileNotFoundException is thrown.

Parameters:

file - the File on which to stream reads.

Throws:

IOException - If an error occurs opening the file.

ReliableFileInputStream

public ReliableFileInputStream(File file,
                       int generation,
                       int openMask)
                        throws IOException

Constructs a new ReliableFileInputStream on the File file. If the file does not exist, the FileNotFoundException is thrown.

Parameters:

file - the File on which to stream reads.

generation - a specific generation requested.

openMask - mask used to open data. are invalid (corrupt, missing, etc).

Throws:

IOException - If an error occurs opening the file.

Method Detail

close

public void close()
           throws IOException

Closes this input stream and releases any system resources associated with the stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException - If an error occurs closing the file.

read

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

Override default FilterInputStream method.

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

FilterInputStream.read(byte[], int, int)

read

public int read(byte[] b)
         throws IOException

Override default FilterInputStream method.

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

FilterInputStream.read(byte[])

read

public int read()
         throws IOException

Override default FilterInputStream method.

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

FilterInputStream.read()

available

public int available()
              throws IOException

Override default available method.

Overrides:

available in class FilterInputStream

Throws:

IOException

See Also:

FilterInputStream.available()

skip

public long skip(long n)
          throws IOException

Override default skip method.

Overrides:

skip in class FilterInputStream

Throws:

IOException

See Also:

FilterInputStream.skip(long)

markSupported

public boolean markSupported()

Override default markSupported method.

Overrides:

markSupported in class FilterInputStream

See Also:

FilterInputStream.markSupported()

mark

public void mark(int readlimit)

Override default mark method.

Overrides:

mark in class FilterInputStream

See Also:

FilterInputStream.mark(int)

reset

public void reset()
           throws IOException

Override default reset method.

Overrides:

reset in class FilterInputStream

Throws:

IOException

See Also:

FilterInputStream.reset()