Java Doc for FilterOutputStream.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.FilterOutputStream

All known Subclasses:   java.io.PrintStream,  java.io.BufferedOutputStream,  java.io.DataOutputStream,
FilterOutputStream
public class FilterOutputStream extends OutputStream (Code)
This class is the superclass of all classes that filter output streams. These streams sit on top of an already existing output stream (the underlying output stream) which it uses as its basic sink of data, but possibly transforming the data along the way or providing additional functionality.

The class FilterOutputStream itself simply overrides all methods of OutputStream with versions that pass all requests to the underlying output stream. Subclasses of FilterOutputStream may further override some of these methods as well as provide additional methods and fields.
author:
   Jonathan Payne
version:
   1.38, 05/05/07
since:
   JDK1.0



Field Summary
protected  OutputStreamout
     The underlying output stream to be filtered.

Constructor Summary
public  FilterOutputStream(OutputStream out)
     Creates an output stream filter built on top of the specified underlying output stream.

Method Summary
public  voidclose()
     Closes this output stream and releases any system resources associated with the stream.
public  voidflush()
     Flushes this output stream and forces any buffered output bytes to be written out to the stream.
public  voidwrite(int b)
     Writes the specified byte to this output stream.
public  voidwrite(byte b)
     Writes b.length bytes to this output stream.
public  voidwrite(byte b, int off, int len)
     Writes len bytes from the specified byte array starting at offset off to this output stream.

Field Detail
out
protected OutputStream out(Code)
The underlying output stream to be filtered.




Constructor Detail
FilterOutputStream
public FilterOutputStream(OutputStream out)(Code)
Creates an output stream filter built on top of the specified underlying output stream.
Parameters:
  out - the underlying output stream to be assigned to the field this.out for later use, or null if this instance is to be created without an underlying stream.




Method Detail
close
public void close() throws IOException(Code)
Closes this output stream and releases any system resources associated with the stream.

The close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterOutputStream.flush
See Also:   java.io.FilterOutputStream.out




flush
public void flush() throws IOException(Code)
Flushes this output stream and forces any buffered output bytes to be written out to the stream.

The flush method of FilterOutputStream calls the flush method of its underlying output stream.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterOutputStream.out




write
public void write(int b) throws IOException(Code)
Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.
Parameters:
  b - the byte.
exception:
  IOException - if an I/O error occurs.




write
public void write(byte b) throws IOException(Code)
Writes b.length bytes to this output stream.

The write method of FilterOutputStream calls its write method of three arguments with the arguments b, 0, and b.length.

Note that this method does not call the one-argument write method of its underlying stream with the single argument b.
Parameters:
  b - the data to be written.
exception:
  IOException - if an I/O error occurs.
See Also:   java.io.FilterOutputStream.write(byte[]intint)




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 output stream.

The write method of FilterOutputStream calls the write method of one argument on each byte to output.

Note that this method does not call the write method of its underlying input stream with the same arguments. Subclasses of FilterOutputStream should provide a more efficient implementation of this method.
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.
See Also:   java.io.FilterOutputStream.write(int)




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.