info.guardianproject.iocipher

Class FileInputStream

java.lang.Object

java.io.InputStream

info.guardianproject.iocipher.FileInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class FileInputStream
extends java.io.InputStream
implements java.io.Closeable

An input stream that reads bytes from a file.

 
   File file = ...
   InputStream in = null;
   try {
     in = new BufferedInputStream(new FileInputStream(file));
     ...
   } finally {
     if (in != null) {
       in.close();
     }
   }
 
 

This stream is not buffered. Most callers should wrap this stream with a BufferedInputStream.

Use FileReader to read characters, as opposed to bytes, from a file.

See Also:

BufferedInputStream, FileOutputStream

Constructor Summary

Constructors

Constructor and Description
FileInputStream(File file) Constructs a new FileInputStream that reads from file.
FileInputStream(FileDescriptor fd) Constructs a new FileInputStream that reads from fd.
FileInputStream(java.lang.String path) Equivalent to new FileInputStream(new File(path)).

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
protected void	finalize() Ensures that all resources for this stream are released when it is about to be garbage collected.
IOCipherFileChannel	getChannel() Returns a read-only IOCipherFileChannel that shares its position with this stream.
FileDescriptor	getFD() Returns the underlying file descriptor.
int	read()
int	read(byte[] b)
int	read(byte[] buffer, int byteOffset, int byteCount)
static int	readSingleByte(java.io.InputStream in)
long	skip(long byteCount)

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInputStream

public FileInputStream(File file)
                throws java.io.FileNotFoundException

Constructs a new FileInputStream that reads from file.

Parameters:

file - the file from which this stream reads.

Throws:

java.io.FileNotFoundException - if file does not exist.

FileInputStream

public FileInputStream(FileDescriptor fd)

Constructs a new FileInputStream that reads from fd.

Parameters:

fd - the FileDescriptor from which this stream reads.

Throws:

java.lang.NullPointerException - if fd is null.

FileInputStream

public FileInputStream(java.lang.String path)
                throws java.io.FileNotFoundException

Equivalent to new FileInputStream(new File(path)).

Throws:

java.io.FileNotFoundException

Method Detail

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

finalize

protected void finalize()
                 throws java.io.IOException

Ensures that all resources for this stream are released when it is about to be garbage collected.

Overrides:

finalize in class java.lang.Object

Throws:

java.io.IOException - if an error occurs attempting to finalize this stream.

getChannel

public IOCipherFileChannel getChannel()

Returns a read-only IOCipherFileChannel that shares its position with this stream.

getFD

public final FileDescriptor getFD()
                           throws java.io.IOException

Returns the underlying file descriptor.

Throws:

java.io.IOException

readSingleByte

public static int readSingleByte(java.io.InputStream in)
                          throws java.io.IOException

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] buffer,
                int byteOffset,
                int byteCount)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

skip

public long skip(long byteCount)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException