info.guardianproject.iocipher

Class FileOutputStream

java.lang.Object

java.io.OutputStream

info.guardianproject.iocipher.FileOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class FileOutputStream
extends java.io.OutputStream
implements java.io.Closeable

An output stream that writes bytes to a file. If the output file exists, it can be replaced or appended to. If it does not exist, a new file will be created.

 
   File file = ...
   OutputStream out = null;
   try {
     out = new BufferedOutputStream(new FileOutputStream(file));
     ...
   } finally {
     if (out != null) {
       out.close();
     }
   }
 
 

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

Use FileWriter to write characters, as opposed to bytes, to a file.

See Also:

BufferedOutputStream, FileInputStream

Constructor Summary

Constructors

Constructor and Description
FileOutputStream(File file) Constructs a new FileOutputStream that writes to file.
FileOutputStream(File file, boolean append) Constructs a new FileOutputStream that writes to file.
FileOutputStream(FileDescriptor fd) Constructs a new FileOutputStream that writes to fd.
FileOutputStream(java.lang.String path) Constructs a new FileOutputStream that writes to path.
FileOutputStream(java.lang.String path, boolean append) Constructs a new FileOutputStream that writes to path.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
IOCipherFileChannel	getChannel() Returns a write-only IOCipherFileChannel that shares its position with this stream.
FileDescriptor	getFD() Returns the underlying file descriptor.
void	write(byte[] buffer, int byteOffset, int byteCount)
void	write(int oneByte)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FileOutputStream

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

Constructs a new FileOutputStream that writes to file. The file will be truncated if it exists, and created if it doesn't exist.

Throws:

java.io.FileNotFoundException - if file cannot be opened for writing.

FileOutputStream

public FileOutputStream(File file,
                        boolean append)
                 throws java.io.FileNotFoundException

Constructs a new FileOutputStream that writes to file. If append is true and the file already exists, it will be appended to; otherwise it will be truncated. The file will be created if it does not exist.

Throws:

java.io.FileNotFoundException - if the file cannot be opened for writing.

FileOutputStream

public FileOutputStream(FileDescriptor fd)

Constructs a new FileOutputStream that writes to fd.

Throws:

java.lang.NullPointerException - if fd is null.

FileOutputStream

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

Constructs a new FileOutputStream that writes to path. The file will be truncated if it exists, and created if it doesn't exist.

Throws:

java.io.FileNotFoundException - if file cannot be opened for writing.

FileOutputStream

public FileOutputStream(java.lang.String path,
                        boolean append)
                 throws java.io.FileNotFoundException

Constructs a new FileOutputStream that writes to path. If append is true and the file already exists, it will be appended to; otherwise it will be truncated. The file will be created if it does not exist.

Throws:

java.io.FileNotFoundException - if the file cannot be opened for writing.

Method Detail

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.OutputStream

Throws:

java.io.IOException

finalize

protected void finalize()
                 throws java.io.IOException

Overrides:

finalize in class java.lang.Object

Throws:

java.io.IOException

getChannel

public IOCipherFileChannel getChannel()

Returns a write-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

write

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

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(int oneByte)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException