Module java.base
Package java.io

Class FilterOutputStream

    • Field Summary

      Fields 
      Modifier and TypeFieldDescription
      protectedOutputStreamout
      The underlying output stream to be filtered.
    • Constructor Summary

      Constructors 
      ConstructorDescription
      FilterOutputStream​(OutputStream out)
      Creates an output stream filter built on top of the specified underlying output stream.
    • Field Detail

      • out

        protected OutputStream out
        The underlying output stream to be filtered.
    • Constructor Detail

      • FilterOutputStream

        public FilterOutputStream​(OutputStream out)
        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 fieldthis.out for later use, ornull if this instance is to be created without an underlying stream.
    • Method Detail

      • write

        public void write​(int b)           throwsIOException
        Writes the specifiedbyte to this output stream.

        Thewrite method ofFilterOutputStream calls thewrite method of its underlying output stream, that is, it performsout.write(b).

        Implements the abstractwrite method ofOutputStream.

        Specified by:
        write in class OutputStream
        Parameters:
        b - thebyte.
        Throws:
        IOException - if an I/O error occurs.
      • write

        public void write​(byte[] b)           throwsIOException
        Writesb.length bytes to this output stream.

        Thewrite method ofFilterOutputStream calls itswrite method of three arguments with the argumentsb,0, andb.length.

        Note that this method does not call the one-argumentwrite method of its underlying output stream with the single argumentb.

        Overrides:
        write in class OutputStream
        Parameters:
        b - the data to be written.
        Throws:
        IOException - if an I/O error occurs.
        See Also:
        write(byte[], int, int)
      • write

        public void write​(byte[] b,                  int off,                  int len)           throwsIOException
        Writeslen bytes from the specifiedbyte array starting at offsetoff to this output stream.

        Thewrite method ofFilterOutputStream calls thewrite method of one argument on eachbyte to output.

        Note that this method does not call thewrite method of its underlying output stream with the same arguments. Subclasses ofFilterOutputStream should provide a more efficient implementation of this method.

        Overrides:
        write in class OutputStream
        Parameters:
        b - the data.
        off - the start offset in the data.
        len - the number of bytes to write.
        Throws:
        IOException - if an I/O error occurs.
        See Also:
        write(int)
      • flush

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

        Theflush method ofFilterOutputStream calls theflush method of its underlying output stream.

        Specified by:
        flush in interface Flushable
        Overrides:
        flush in class OutputStream
        Throws:
        IOException - if an I/O error occurs.
        See Also:
        out
      • close

        public void close()           throwsIOException
        Closes this output stream and releases any system resources associated with the stream.

        When not already closed, theclose method of FilterOutputStream calls itsflush method, and then calls theclose method of its underlying output stream.

        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
        Overrides:
        close in class OutputStream
        Throws:
        IOException - if an I/O error occurs.
        See Also:
        flush(),out