Java Doc for FileOutputStream.java in  » 6.0-JDK-Core » io-nio » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.OutputStream
      java.io.FileOutputStream

FileOutputStream
public class FileOutputStream extends OutputStream (Code)
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.68, 06/13/07
See Also:   java.io.File
See Also:   java.io.FileDescriptor
See Also:   java.io.FileInputStream
since:
   JDK1.0




Constructor Summary
public  FileOutputStream(String name)
     Creates an output file stream to write to the file with the specified name.
public  FileOutputStream(String name, boolean append)
     Creates an output file stream to write to the file with the specified name.
public  FileOutputStream(File file)
     Creates a file output stream to write to the file represented by the specified File object.
public  FileOutputStream(File file, boolean append)
     Creates a file output stream to write to the file represented by the specified File object.
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.

If fdObj is null then a NullPointerException is thrown.

This constructor does not throw an exception if fdObj is {link java.io.FileDescriptor#valid() invalid}. However, if the methods are invoked on the resulting stream to attempt I/O on the stream, an IOException is thrown.


Method Summary
public  voidclose()
     Closes this file output stream and releases any system resources associated with this stream.
protected  voidfinalize()
     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.
public  FileChannelgetChannel()
     Returns the unique java.nio.channels.FileChannel FileChannel object associated with this file output stream.
final public  FileDescriptorgetFD()
     Returns the file descriptor associated with this stream. the FileDescriptor object that represents the connection to the file in the file system being used by this FileOutputStream object.
native public  voidwrite(int b)
     Writes the specified byte to this file output stream.
public  voidwrite(byte b)
     Writes b.length bytes from the specified byte array to this file output stream.
public  voidwrite(byte b, int off, int len)
     Writes len bytes from the specified byte array starting at offset off to this file output stream.


Constructor Detail
FileOutputStream
public FileOutputStream(String name) throws FileNotFoundException(Code)
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
exception:
  FileNotFoundException - if the file exists but is a directoryrather than a regular file, does not exist but cannotbe created, or cannot be opened for any other reason
exception:
  SecurityException - if a security manager exists and itscheckWrite method denies write accessto the file.
See Also:   java.lang.SecurityManager.checkWrite(java.lang.String)




FileOutputStream
public FileOutputStream(String name, boolean append) throws FileNotFoundException(Code)
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
Parameters:
  append - if true, then bytes will be writtento the end of the file rather than the beginning
exception:
  FileNotFoundException - if the file exists but is a directoryrather than a regular file, does not exist but cannotbe created, or cannot be opened for any other reason.
exception:
  SecurityException - if a security manager exists and itscheckWrite method denies write accessto the file.
See Also:   java.lang.SecurityManager.checkWrite(java.lang.String)
since:
   JDK1.1




FileOutputStream
public FileOutputStream(File file) throws FileNotFoundException(Code)
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.
exception:
  FileNotFoundException - if the file exists but is a directoryrather than a regular file, does not exist but cannotbe created, or cannot be opened for any other reason
exception:
  SecurityException - if a security manager exists and itscheckWrite method denies write accessto the file.
See Also:   java.io.File.getPath
See Also:   java.lang.SecurityException
See Also:   java.lang.SecurityManager.checkWrite(java.lang.String)




FileOutputStream
public FileOutputStream(File file, boolean append) throws FileNotFoundException(Code)
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.
Parameters:
  append - if true, then bytes will be writtento the end of the file rather than the beginning
exception:
  FileNotFoundException - if the file exists but is a directoryrather than a regular file, does not exist but cannotbe created, or cannot be opened for any other reason
exception:
  SecurityException - if a security manager exists and itscheckWrite method denies write accessto the file.
See Also:   java.io.File.getPath
See Also:   java.lang.SecurityException
See Also:   java.lang.SecurityManager.checkWrite(java.lang.String)
since:
   1.4




FileOutputStream
public FileOutputStream(FileDescriptor fdObj)(Code)
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.

If fdObj is null then a NullPointerException is thrown.

This constructor does not throw an exception if fdObj is {link java.io.FileDescriptor#valid() 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
exception:
  SecurityException - if a security manager exists and itscheckWrite method denieswrite access to the file descriptor
See Also:   java.lang.SecurityManager.checkWrite(java.io.FileDescriptor)





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




finalize
protected void finalize() throws IOException(Code)
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 Also:   java.io.FileInputStream.close



getChannel
public FileChannel getChannel()(Code)
Returns the unique java.nio.channels.FileChannel FileChannel object associated with this file output stream.

The initial java.nio.channels.FileChannel.positionposition 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. the file channel associated with this file output stream
since:
   1.4




getFD
final public FileDescriptor getFD() throws IOException(Code)
Returns the file descriptor associated with this stream. 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 Also:   java.io.FileDescriptor



write
native public void write(int b) throws IOException(Code)
Writes the specified byte to this file output stream. Implements the write method of OutputStream.
Parameters:
  b - the byte to be written.
exception:
  IOException - if an I/O error occurs.



write
public void write(byte b) throws IOException(Code)
Writes b.length bytes from the specified byte array to this file output stream.
Parameters:
  b - the data.
exception:
  IOException - if an I/O error occurs.



write
public void write(byte b, int off, int len) throws IOException(Code)
Writes len bytes from the specified byte array starting at offset off to this file output stream.
Parameters:
  b - the data.
Parameters:
  off - the start offset in the data.
Parameters:
  len - the number of bytes to write.
exception:
  IOException - if an I/O error occurs.



Methods inherited from java.io.OutputStream
public void close() throws IOException(Code)(Java Doc)
public void flush() throws IOException(Code)(Java Doc)
abstract public void write(int b) throws IOException(Code)(Java Doc)
public void write(byte b) throws IOException(Code)(Java Doc)
public void write(byte b, int off, int len) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.