Package org.jruby.embed.io

Class WriterOutputStream

java.lang.Object
java.io.OutputStream
org.jruby.embed.io.WriterOutputStream
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable
public class WriterOutputStream extends OutputStream
A WriterOutputStream converts java.io.Writer to java.io.OutputStream.
Author:
Yoko Harada <[email protected]>

  • Constructor Summary

    Constructors
    Constructor
    Description
    WriterOutputStream(Writer writer)
    Creates WriterOutputStream from given java.io.Writer object with a default encoding.
    WriterOutputStream(Writer writer, String encoding)
    Creates WriterOutputStream from given java.io.Writer object with a specified encoding.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes this output stream and releases any system resources associated with this stream.
    void
    flush()
    Flushes this output stream and forces any buffered output bytes to be written out.
    void
    write(byte[] b)
    Writes b.length bytes from the specified byte array to this output stream.
    void
    write(byte[] b, int off, int len)
    Writes len bytes from the specified byte array starting at offset off to this output stream.
    void
    write(int b)
    Writes the specified byte to this output stream.

    Methods inherited from class java.io.OutputStream

    nullOutputStream

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WriterOutputStream

      public WriterOutputStream(Writer writer)
      Creates WriterOutputStream from given java.io.Writer object with a default encoding.
      Parameters:
      writer - java.io.Writer object to be converted to.

    • WriterOutputStream

      public WriterOutputStream(Writer writer, String encoding)
      Creates WriterOutputStream from given java.io.Writer object with a specified encoding.
      Parameters:
      writer - java.io.Writer object to be converted to.

  • Method Details

    • close

      public void close() throws IOException
      Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

      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.

    • flush

      public void flush() throws IOException
      Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

      If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

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

    • write

      public void write(int b) throws IOException
      Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.
      Specified by:
      write in class OutputStream
      Parameters:
      b - the byte.
      Throws:
      IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

    • write

      public void write(byte[] b) throws IOException
      Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).
      Overrides:
      write in class OutputStream
      Parameters:
      b - the data.
      Throws:
      IOException - if an I/O error occurs.
      See Also:

    • write

      public void write(byte[] b, int off, int len) throws IOException
      Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

      If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

      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. In particular, an IOException is thrown if the output stream is closed.