net.java.truevfs.access

Class TFileInputStream

java.lang.Object

java.io.InputStream

net.java.truecommons.io.DecoratingInputStream

net.java.truevfs.access.TFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@Immutable
public final class TFileInputStream
extends net.java.truecommons.io.DecoratingInputStream

A replacement for the class FileInputStream for reading plain old files or entries in an archive file. Mind that applications cannot read archive files directly - just their entries!

To prevent exceptions to be thrown subsequently, applications should always close their streams using the following idiom:

 TFileInputStream in = new TFileInputStream(file);
 try {
     // Do I/O here...
 } finally {
     in.close(); // ALWAYS close the stream!
 }
 

Note that the DecoratingInputStream.close() method may throw an IOException, too. Applications need to deal with this appropriately, for example by enclosing the entire block with another try-catch-block:

 try {
     TFileInputStream in = new TFileInputStream(file);
     try {
         // Do I/O here...
     } finally {
         in.close(); // ALWAYS close the stream!
     }
 } catch (IOException ex) {
     ex.printStackTrace();
 }
 

Applications cannot read from an entry in an archive file if an implicit unmount is required but cannot get performed because another TFileInputStream or TFileOutputStream object hasn't been closed or garbage collected yet. A FileNotFoundException is thrown by the constructors of this class in this case.

If you would like to use this class in order to cp files, please consider using one of the cp methods of the class TFile instead. These methods provide ease of use, enhanced features, superior performance and require less space in the temp file folder.

Author:

Christian Schlichtherle

See Also:

TFile.cat(InputStream, OutputStream), TFileOutputStream

Field Summary

Fields inherited from class net.java.truecommons.io.DecoratingInputStream

in

Constructor Summary

Constructors

Constructor and Description
TFileInputStream(File file) Constructs a new input stream for reading plain old files or entries in an archive file.
TFileInputStream(File file, net.java.truecommons.shed.BitField<FsAccessOption> options) Constructs a new input stream for reading plain old files or entries in an archive file.
TFileInputStream(File file, FsAccessOption... options) Constructs a new input stream for reading plain old files or entries in an archive file.
TFileInputStream(String path) Constructs a new input stream for reading plain old files or entries in an archive file.
TFileInputStream(String path, FsAccessOption... options) Constructs a new input stream for reading plain old files or entries in an archive file.

Method Summary

Methods inherited from class net.java.truecommons.io.DecoratingInputStream

available, close, mark, markSupported, read, read, read, reset, skip, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TFileInputStream

@CreatesObligation
public TFileInputStream(File file)
                                    throws IOException

Constructs a new input stream for reading plain old files or entries in an archive file.

Parameters:

file - the file or archive entry.

Throws:

IOException - on any I/O error.

TFileInputStream

@CreatesObligation
public TFileInputStream(File file,
                                           net.java.truecommons.shed.BitField<FsAccessOption> options)
                                    throws IOException

Constructs a new input stream for reading plain old files or entries in an archive file.

Parameters:

file - the file or archive entry.

options - additional options for accessing the file or archive entry.

Throws:

IOException - on any I/O error.

TFileInputStream

@CreatesObligation
public TFileInputStream(File file,
                                           FsAccessOption... options)
                                    throws IOException

Constructs a new input stream for reading plain old files or entries in an archive file.

Parameters:

file - the file or archive entry.

options - additional options for accessing the file or archive entry.

Throws:

IOException - on any I/O error.

TFileInputStream

@CreatesObligation
public TFileInputStream(String path)
                                    throws IOException

Constructs a new input stream for reading plain old files or entries in an archive file.

Parameters:

path - the path of the file or archive entry.

Throws:

IOException - on any I/O error.

TFileInputStream

@CreatesObligation
public TFileInputStream(String path,
                                           FsAccessOption... options)
                                    throws IOException

Constructs a new input stream for reading plain old files or entries in an archive file.

Parameters:

path - the path of the file or archive entry.

options - additional options for accessing the file or archive entry.

Throws:

IOException - on any I/O error.