java.io.FileOutputStream Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.io;
/**
* 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.
*
* @author Arthur van Hoff
* @version 1.39, 02/02/00
* @see java.io.File
* @see java.io.FileDescriptor
* @see java.io.FileInputStream
* @since JDK1.0
*/
public class FileOutputStream extends OutputStream
{
/**
* 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.
*
* @param name the system-dependent filename
* @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 java.lang.SecurityManager#checkWrite(java.lang.String)
*/
public FileOutputStream(String name) 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.
*
* @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
* @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 java.lang.SecurityManager#checkWrite(java.lang.String)
* @since JDK1.1
*/
public FileOutputStream(String name, boolean append)
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.
*
* @param file the file to be opened for writing.
* @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 java.io.File#getPath()
* @see java.lang.SecurityException
* @see java.lang.SecurityManager#checkWrite(java.lang.String)
*/
public FileOutputStream(File file) 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.
*
* @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
* @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 java.io.File#getPath()
* @see java.lang.SecurityException
* @see java.lang.SecurityManager#checkWrite(java.lang.String)
* @since 1.4
*/
public FileOutputStream(File file, boolean append)
throws FileNotFoundException
{ }
/**
* 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.
*
* @param fdObj the file descriptor to be opened for writing
* @exception SecurityException if a security manager exists and its
* checkWrite method denies
* write access to the file descriptor
* @see java.lang.SecurityManager#checkWrite(java.io.FileDescriptor)
*/
public FileOutputStream(FileDescriptor fdObj) { }
/**
* Writes the specified byte to this file output stream. Implements
* the write method of OutputStream.
*
* @param b the byte to be written.
* @exception IOException if an I/O error occurs.
*/
public void write(int b) throws IOException { }
/**
* Writes b.length bytes from the specified byte array
* to this file output stream.
*
* @param b the data.
* @exception IOException if an I/O error occurs.
*/
public void write(byte[] b) throws IOException { }
/**
* Writes len bytes from the specified byte array
* starting at offset off to this file output stream.
*
* @param b the data.
* @param off the start offset in the data.
* @param len the number of bytes to write.
* @exception IOException if an I/O error occurs.
*/
public void write(byte[] b, int off, int len) 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.
*
* @exception IOException if an I/O error occurs.
*
* @revised 1.4
* @spec JSR-51
*/
public void close() throws IOException { }
/**
* Returns the file descriptor associated with this stream.
*
* @return the FileDescriptor object that represents
* the connection to the file in the file system being used
* by this FileOutputStream object.
*
* @exception IOException if an I/O error occurs.
* @see java.io.FileDescriptor
*/
public final FileDescriptor getFD() throws IOException {
return null;
}
/**
* 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.
*
* @exception IOException if an I/O error occurs.
* @see java.io.FileInputStream#close()
*/
protected void finalize() throws IOException { }
}