|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class FileOutputStream
java.io.FileOutputStream
All Implemented Interfaces:
public class 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.
Implementation Requirements:
If this FileOutputStream has been subclassed and the
close()
method has been overridden, the
close() method will be
called when the FileInputStream is unreachable.
Otherwise, it is implementation specific how the resource cleanup described in
close() is performed.
Since:
1.0
Author:
Arthur van Hoff
See Also:
Constructor Summary |
Creates a file output stream to write to the file represented by
the specified File object.
|
Creates a file output stream to write to the file represented by
the specified File object.
|
Creates a file output stream to write to the specified file
descriptor, which represents an existing connection to an actual
file in the file system.
|
Creates a file output stream to write to the file with the
specified name.
|
Creates a file output stream to write to the file with the specified
name.
|
Method Summary |
void |
Closes this file output stream and releases any system resources
associated with this stream.
|
|
Returns the unique FileChannel
object associated with this file output stream.
|
|
Returns the file descriptor associated with this stream.
|
void |
Writes b.length bytes from the specified byte array
to this file output stream.
|
void |
write(byte[] b, int off, int len)
Writes len bytes from the specified byte array
starting at offset off to this file output stream.
|
void |
Writes the specified byte to this file output stream.
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public FileOutputStream |
|
throws |
|
Creates a file output 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.
Implementation Requirements:
Parameters:
name - the system-dependent filename
Throws:
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
SecurityException - if a security manager exists and its
checkWrite method denies write access
to the file.
See Also:
public FileOutputStream |
|
throws |
|
Creates a file output 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
Throws:
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.
SecurityException - if a security manager exists and its
checkWrite method denies write access
to the file.
Since:
1.1
See Also:
public FileOutputStream |
|
throws |
|
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.
Throws:
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
SecurityException - if a security manager exists and its
checkWrite method denies write access
to the file.
See Also:
public FileOutputStream |
( File file, boolean append) |
throws |
|
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
Throws:
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
SecurityException - if a security manager exists and its
checkWrite method denies write access
to the file.
Since:
1.4
See Also:
Creates a file output 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.
If fdObj is null then a NullPointerException
is thrown.
This constructor does not throw an exception if fdObj
is invalid.
However, if the methods are invoked on the resulting stream to attempt
I/O on the stream, an IOException is thrown.
Parameters:
fdObj - the file descriptor to be opened for writing
Throws:
SecurityException - if a security manager exists and its
checkWrite method denies
write access to the file descriptor
See Also:
public void write |
(int b) |
throws |
|
Writes the specified byte to this file output stream. Implements
the
write method of
OutputStream.
Overrides:
Parameters:
b - the byte to be written.
Throws:
public void write |
(byte[] b) |
throws |
|
Writes
b.length bytes from the specified byte array
to this file output stream.
Overrides:
Parameters:
b - the data.
Throws:
See Also:
public void write |
(byte[] b, int off, int len) |
throws |
|
Writes
len bytes from the specified byte array
starting at offset
off to this file output stream.
Overrides:
Parameters:
b - the data.
off - the start offset in the data.
len - the number of bytes to write.
Throws:
public void close |
() |
throws |
|
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.
Specified by:
Overrides:
Throws:
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.
Throws:
See Also:
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
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz