BufferedOutputStream (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.io.OutputStream
  • • java.io.FilterOutputStream
      • • java.io.BufferedOutputStream

• All Implemented Interfaces:
  [Closeable](../../java/io/Closeable.html "interface in java.io"), [Flushable](../../java/io/Flushable.html "interface in java.io"), [AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")

public class BufferedOutputStream
extends FilterOutputStream
The class implements a buffered output stream. By setting up such an output stream, an application can write bytes to the underlying output stream without necessarily causing a call to the underlying system for each byte written.
Since:
1.0

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  protected byte[]	buf	The internal buffer where data is stored.
  protected int	count	The number of valid bytes in the buffer.

     * ### Fields inherited from class java.io.[FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")  
     `[out](../../java/io/FilterOutputStream.html#out)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  BufferedOutputStream​(OutputStream out)	Creates a new buffered output stream to write data to the specified underlying output stream.
  BufferedOutputStream​(OutputStream out, int size)	Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  void	flush​()	Flushes this buffered output stream.
  void	write​(byte[] b, int off, int len)	Writes len bytes from the specified byte array starting at offset off to this buffered output stream.
  void	write​(int b)	Writes the specified byte to this buffered output stream.

     * ### Methods inherited from class java.io.[FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")  
     `[close](../../java/io/FilterOutputStream.html#close--), [write](../../java/io/FilterOutputStream.html#write-byte:A-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### buf  
     protected byte[] buf  
     The internal buffer where data is stored.  
     * #### count  
     protected int count  
     The number of valid bytes in the buffer. This value is always in the range `0` through `buf.length`; elements`buf[0]` through `buf[count-1]` contain valid byte data.  

  • Constructor Detail

    * #### BufferedOutputStream  
    public BufferedOutputStream​([OutputStream](../../java/io/OutputStream.html "class in java.io") out)  
    Creates a new buffered output stream to write data to the specified underlying output stream.  
    Parameters:  
    `out` \- the underlying output stream.  
    * #### BufferedOutputStream  
    public BufferedOutputStream​([OutputStream](../../java/io/OutputStream.html "class in java.io") out,  
                                int size)  
    Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.  
    Parameters:  
    `out` \- the underlying output stream.  
    `size` \- the buffer size.  
    Throws:  
    `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if size <= 0.  

  • Method Detail

    * #### write  
    public void write​(int b)  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    Writes the specified byte to this buffered output stream.  
    Overrides:  
    `[write](../../java/io/FilterOutputStream.html#write-int-)` in class `[FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")`  
    Parameters:  
    `b` \- the byte to be written.  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    * #### write  
    public void write​(byte[] b,  
                      int off,  
                      int len)  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    Writes `len` bytes from the specified byte array starting at offset `off` to this buffered output stream.  
     Ordinarily this method stores bytes from the given array into this stream's buffer, flushing the buffer to the underlying output stream as needed. If the requested length is at least as large as this stream's buffer, however, then this method will flush the buffer and write the bytes directly to the underlying output stream. Thus redundant`BufferedOutputStream`s will not copy data unnecessarily.  
    Overrides:  
    `[write](../../java/io/FilterOutputStream.html#write-byte:A-int-int-)` in class `[FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")`  
    Parameters:  
    `b` \- the data.  
    `off` \- the start offset in the data.  
    `len` \- the number of bytes to write.  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [FilterOutputStream.write(int)](../../java/io/FilterOutputStream.html#write-int-)  
    * #### flush  
    public void flush​()  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    Flushes this buffered output stream. This forces any buffered output bytes to be written out to the underlying output stream.  
    Specified by:  
    `[flush](../../java/io/Flushable.html#flush--)` in interface `[Flushable](../../java/io/Flushable.html "interface in java.io")`  
    Overrides:  
    `[flush](../../java/io/FilterOutputStream.html#flush--)` in class `[FilterOutputStream](../../java/io/FilterOutputStream.html "class in java.io")`  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [FilterOutputStream.out](../../java/io/FilterOutputStream.html#out)

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.