Class: java.io.FileOutputStream

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.

Authors:
@author Arthur van Hoff
See:
@see java.io.File
@see java.io.FileDescriptor
@see java.io.FileInputStream
Since:
@since JDK1.0

Inheritance

Superclass tree: Implements:

Methods

  • FileOutputStreamtop

    public FileOutputStream(File file) throws FileNotFoundException
    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:
    @param file the file to be opened for writing.
    Exceptions:
    @exception FileNotFoundException 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
    @exception SecurityException if a security manager exists and its checkWrite method denies write access to the file.
    See:
    @see java.io.File.getPath()
    @see SecurityException
    @see SecurityManager.checkWrite(java.lang.String)
    Related Links:
    Google Code Search
    Stack Overflow

  • FileOutputStreamtop

    public FileOutputStream(File file, boolean append) throws FileNotFoundException
    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:
    @param file the file to be opened for writing.
    @param append if true, then bytes will be written to the end of the file rather than the beginning
    Exceptions:
    @exception FileNotFoundException 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
    @exception SecurityException if a security manager exists and its checkWrite method denies write access to the file.
    See:
    @see java.io.File.getPath()
    @see SecurityException
    @see SecurityManager.checkWrite(java.lang.String)
    Since:
    @since 1.4
    Related Links:
    Google Code Search
    Stack Overflow

  • FileOutputStreamtop

    public FileOutputStream(FileDescriptor fdObj)
    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:
    @param fdObj the file descriptor to be opened for writing
    Exceptions:
    @exception SecurityException if a security manager exists and its checkWrite method denies write access to the file descriptor
    See:
    @see SecurityManager.checkWrite(java.io.FileDescriptor)
    Related Links:
    Google Code Search
    Stack Overflow

  • FileOutputStreamtop

    public FileOutputStream(String name) throws FileNotFoundException
    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:
    @param name the system-dependent filename
    Exceptions:
    @exception FileNotFoundException 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
    @exception SecurityException if a security manager exists and its checkWrite method denies write access to the file.
    See:
    @see SecurityManager.checkWrite(java.lang.String)
    Related Links:
    Google Code Search
    Stack Overflow

  • FileOutputStreamtop

    public FileOutputStream(String name, boolean append) throws FileNotFoundException
    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:
    @param name the system-dependent file name
    @param append if true, then bytes will be written to the end of the file rather than the beginning
    Exceptions:
    @exception FileNotFoundException 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.
    @exception SecurityException if a security manager exists and its checkWrite method denies write access to the file.
    See:
    @see SecurityManager.checkWrite(java.lang.String)
    Since:
    @since JDK1.1
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close() throws IOException
    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.

    Exceptions:
    @exception IOException if an I/O error occurs.
    Misc:
    @revised 1.4
    @spec JSR-51
    Specified by:
    close from Closeable
    Override hierarchy:
    close from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • finalizetop

    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.
    Exceptions:
    @exception IOException if an I/O error occurs.
    See:
    @see java.io.FileInputStream.close()
    Override hierarchy:
    finalize from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • getChanneltop

    public FileChannel getChannel()
    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.

    Return:
    @return the file channel associated with this file output stream
    Since:
    @since 1.4
    Misc:
    @spec JSR-51
    Related Links:
    Google Code Search
    Stack Overflow

  • getFDtop

    public final FileDescriptor getFD() throws IOException
    Returns the file descriptor associated with this stream.
    Return:
    @return the FileDescriptor object that represents the connection to the file in the file system being used by this FileOutputStream object.
    Exceptions:
    @exception IOException if an I/O error occurs.
    See:
    @see java.io.FileDescriptor
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public native void write(int b) throws IOException
    Writes the specified byte to this file output stream. Implements the write method of OutputStream.
    Parameters:
    @param b the byte to be written.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Override hierarchy:
    write from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(byte[] b) throws IOException
    Writes b.length bytes from the specified byte array to this file output stream.
    Parameters:
    @param b the data.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Override hierarchy:
    write from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow

  • writetop

    public void write(byte[] b, int off, int len) throws IOException
    Writes len bytes from the specified byte array starting at offset off to this file output stream.
    Parameters:
    @param b the data.
    @param off the start offset in the data.
    @param len the number of bytes to write.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Override hierarchy:
    write from OutputStream
    Related Links:
    Google Code Search
    Stack Overflow