org.jruby.util

Class IOChannel

java.lang.Object

org.jruby.util.IOChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel

Direct Known Subclasses:

IOChannel.IOReadableByteChannel, IOChannel.IOReadableWritableByteChannel, IOChannel.IOWritableByteChannel

public abstract class IOChannel
extends Object
implements Channel

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOChannel.IOReadableByteChannel
static class	IOChannel.IOReadableWritableByteChannel
static class	IOChannel.IOWritableByteChannel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IOChannel(IRubyObject io) Creates a new OutputStream with the object provided.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected CallSite	initReadSite()
protected CallSite	initWriteSite()
boolean	isOpen()
protected int	read(CallSite read, ByteBuffer dst)
protected int	write(CallSite write, ByteBuffer src)

Methods inherited from class java.lang.Object

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

Constructor Detail

IOChannel

protected IOChannel(IRubyObject io)

Creates a new OutputStream with the object provided.

Parameters:

io - the ruby object

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

read

protected int read(CallSite read,
       ByteBuffer dst)
            throws IOException

Throws:

IOException

write

protected int write(CallSite write,
        ByteBuffer src)
             throws IOException

Throws:

IOException

initReadSite

protected CallSite initReadSite()

initWriteSite

protected CallSite initWriteSite()