Top Description Fields Constructors Methods
org.jruby.util

public Class IOOutputStream

extends OutputStream
Class Inheritance
Imports
java.io.OutputStream, .IOException, org.jcodings.Encoding, org.jcodings.specific.ASCIIEncoding, org.jruby.Ruby, .RubyIO, .RubyString, org.jruby.runtime.CallSite, .ThreadContext, .MethodIndex, org.jruby.runtime.builtin.IRubyObject
This class wraps a IRubyObject in an OutputStream. Depending on which messages the IRubyObject answers to, it will have different functionality. The point is that the IRubyObject could exhibit duck typing, in the style of IO versus StringIO, for example. At the moment, the only functionality supported is writing, and the only requirement on the io-object is that it responds to write() and close() like IO.
Author
Ola Bini

Field Summary

Modifier and TypeField and Description
private final CallSite
closeAdapter

private final Encoding
encoding

private final IRubyObject
io

private final RubyIO
realIO

private final Ruby
runtime

private final CallSite
writeAdapter

Constructor Summary

AccessConstructor and Description
public
IOOutputStream(final IRubyObject
the ruby object
io, Encoding encoding, boolean checkAppend, boolean verifyCanWrite)

Creates a new OutputStream with the object provided.

public
IOOutputStream(final IRubyObject io, boolean checkAppend, boolean verifyCanWrite)

public
IOOutputStream(final IRubyObject
the ruby object
io)

Creates a new OutputStream with the object provided.

public
IOOutputStream(final IRubyObject io, Encoding encoding)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

protected boolean
fastWritable(RubyIO io)

protected RubyIO
getRealIO(IRubyObject io)

public void
write(final int
the byte.
bite)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.

public void
write(final byte[]
the data.
b)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.

public void
write(final byte[]
the data.
b, final int
the start offset in the data.
off, final int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Inherited from java.io.OutputStream:
flushnullOutputStream

Field Detail

closeAdapterback to summary
private final CallSite closeAdapter
encodingback to summary
private final Encoding encoding
ioback to summary
private final IRubyObject io
realIOback to summary
private final RubyIO realIO
runtimeback to summary
private final Ruby runtime
writeAdapterback to summary
private final CallSite writeAdapter

Constructor Detail

IOOutputStreamback to summary
public IOOutputStream(final IRubyObject io, Encoding encoding, boolean checkAppend, boolean verifyCanWrite)

Creates a new OutputStream with the object provided.

Parameters
io:IRubyObject

the ruby object

IOOutputStreamback to summary
public IOOutputStream(final IRubyObject io, boolean checkAppend, boolean verifyCanWrite)
IOOutputStreamback to summary
public IOOutputStream(final IRubyObject io)

Creates a new OutputStream with the object provided.

Parameters
io:IRubyObject

the ruby object

IOOutputStreamback to summary
public IOOutputStream(final IRubyObject io, Encoding encoding)

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

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.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
fastWritableback to summary
protected boolean fastWritable(RubyIO io)
getRealIOback to summary
protected RubyIO getRealIO(IRubyObject io)
writeback to summary
public void write(final int bite) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

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.

Parameters
bite:int

the byte.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(final byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

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).

Parameters
b:byte[]

the data.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

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 b is null, a NullPointerException is thrown.

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.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.