java.io
Class FileOutputStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--java.io.FileOutputStream

Direct Known Subclasses:

SocketOutputStream

public class FileOutputStream

extends OutputStream

Safe: A file output stream is an output stream for writing data to a File or to a FileDescriptor. Whether or not a file is available or may be created depends upon the underlying platform. Some platforms, in particular, allow a file to be opened for writing by only one FileOutputStream (or other file-writing object) at a time. In such situations the constructors in this class will fail if the file involved is already open.

FileOutputStream is meant for writing streams of raw bytes such as image data. For writing streams of characters, consider using FileWriter.

Since:

JDK1.0

Version:

1.54, 02/06/02

Author:

Arthur van Hoff

See Also:

java.io.File, java.io.FileDescriptor, java.io.FileInputStream

Field Summary

private boolean	append
private java.nio.channels.FileChannel	channel
private FileDescriptor	fd The system dependent file descriptor.

Constructor Summary

FileOutputStream(File file)
Enabled: Creates a file output stream to write to the file represented by the specified File object.

FileOutputStream(File file, boolean append)
Suppressed: Creates a file output stream to write to the file represented by the specified File object.

FileOutputStream(FileDescriptor fdObj)
Suppressed: Creates an output file stream to write to the specified file descriptor, which represents an existing connection to an actual file in the file system.

FileOutputStream(String name)
Suppressed: Creates an output file stream to write to the file with the specified name.

FileOutputStream(String name, boolean append)
Suppressed: Creates an output file stream to write to the file with the specified name.

Method Summary

void	close() Enabled: Closes this file output stream and releases any system resources associated with this stream.
private void	close0()
protected void	finalize() Cleans up the connection to the file, and ensures that the close method of this file output stream is called when there are no more references to this stream.
java.nio.channels.FileChannel	getChannel() Suppressed: Returns the unique FileChannel object associated with this file output stream.
FileDescriptor	getFD() Suppressed: Returns the file descriptor associated with this stream.
private static void	initIDs()
private void	open(String name) Opens a file, with the specified name, for writing.
private void	openAppend(String name) Opens a file, with the specified name, for appending.
void	write(byte[] b) Enabled: Writes b.length bytes from the specified byte array to this file output stream.
void	write(byte[] b, int off, int len) Enabled: Writes len bytes from the specified byte array starting at offset off to this file output stream.
void	write(int b) Enabled: Writes the specified byte to this file output stream.
private void	writeBytes(byte[] b, int off, int len) Writes a sub array as a sequence of bytes.

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Field Detail

fd

private FileDescriptor fd

The system dependent file descriptor. The value is 1 more than actual file descriptor. This means that the default value 0 indicates that the file is not open.

channel

private java.nio.channels.FileChannel channel

append

private boolean append

Constructor Detail

FileOutputStream

public FileOutputStream(String name)
                 throws FileNotFoundException

Suppressed: Creates an output file stream to write to the file with the specified name. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkWrite method is called with name as its argument.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent filename

See Also:

java.lang.SecurityManager#checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(String name,
                        boolean append)
                 throws FileNotFoundException

Suppressed: Creates an output file stream to write to the file with the specified name. If the second argument is true, then bytes will be written to the end of the file rather than the beginning. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkWrite method is called with name as its argument.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

name - the system-dependent file name

append - if true, then bytes will be written to the end of the file rather than the beginning

Since:

JDK1.1

See Also:

java.lang.SecurityManager#checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(File file)
                 throws FileNotFoundException

Enabled: Creates a file output stream to write to the file represented by the specified File object. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkWrite method is called with the path represented by the file argument as its argument.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for writing.

See Also:

java.io.File#getPath(), java.lang.SecurityException, java.lang.SecurityManager#checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(File file,
                        boolean append)
                 throws FileNotFoundException

Suppressed: Creates a file output stream to write to the file represented by the specified File object. If the second argument is true, then bytes will be written to the end of the file rather than the beginning. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkWrite method is called with the path represented by the file argument as its argument.

If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

Parameters:

file - the file to be opened for writing.

append - if true, then bytes will be written to the end of the file rather than the beginning

Since:

1.4

See Also:

java.io.File#getPath(), java.lang.SecurityException, java.lang.SecurityManager#checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(FileDescriptor fdObj)

Suppressed: Creates an output file stream to write to the specified file descriptor, which represents an existing connection to an actual file in the file system.

First, if there is a security manager, its checkWrite method is called with the file descriptor fdObj argument as its argument.

Parameters:

fdObj - the file descriptor to be opened for writing

See Also:

java.lang.SecurityManager#checkWrite(java.io.FileDescriptor)

Method Detail

open

private void open(String name)
           throws FileNotFoundException

Opens a file, with the specified name, for writing.

Parameters:

name - name of file to be opened

FileNotFoundException

openAppend

private void openAppend(String name)
                 throws FileNotFoundException

Opens a file, with the specified name, for appending.

Parameters:

name - name of file to be opened

FileNotFoundException

write

public void write(int b)
           throws IOException

Enabled: Writes the specified byte to this file output stream. Implements the write method of OutputStream.

Specified by:

write in class OutputStream

Parameters:

b - the byte to be written.

IOException

writeBytes

private void writeBytes(byte[] b,
                        int off,
                        int len)
                 throws IOException

Writes a sub array as a sequence of bytes.

Parameters:

b - the data to be written

off - the start offset in the data

len - the number of bytes that are written

IOException

write

public void write(byte[] b)
           throws IOException

Enabled: Writes b.length bytes from the specified byte array to this file output stream.

Overrides:

write in class OutputStream

Parameters:

b - the data.

IOException

See Also:

java.io.OutputStream#write(byte[], int, int)

write

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

Enabled: Writes len bytes from the specified byte array starting at offset off to this file output stream.

Overrides:

write in class OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

IOException

close

public void close()
           throws IOException

Enabled: Closes this file output stream and releases any system resources associated with this stream. This file output stream may no longer be used for writing bytes.

If this stream has an associated channel then the channel is closed as well.

Overrides:

close in class OutputStream

IOException

getFD

public final FileDescriptor getFD()
                           throws IOException

Suppressed: Returns the file descriptor associated with this stream.

Returns:

the FileDescriptor object that represents the connection to the file in the file system being used by this FileOutputStream object.

IOException

See Also:

java.io.FileDescriptor

getChannel

public java.nio.channels.FileChannel getChannel()

Suppressed: Returns the unique FileChannel object associated with this file output stream.

The initial position of the returned channel will be equal to the number of bytes written to the file so far unless this stream is in append mode, in which case it will be equal to the size of the file. Writing bytes to this stream will increment the channel's position accordingly. Changing the channel's position, either explicitly or by writing, will change this stream's file position.

Returns:

the file channel associated with this file output stream

Since:

1.4

finalize

protected void finalize()
                 throws IOException

Cleans up the connection to the file, and ensures that the close method of this file output stream is called when there are no more references to this stream.

Overrides:

finalize in class Object

IOException

See Also:

java.io.FileInputStream#close()

close0

private void close0()
             throws IOException

IOException

initIDs

private static void initIDs()