Package org.jruby.util

Class IOInputStream

java.lang.Object

java.io.InputStream

org.jruby.util.IOInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class IOInputStream
extends InputStream

This class wraps a IRubyObject in an InputStream. 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 reading, and the only requirement on the io-object is that it responds to read() like IO.

Constructor Summary

Constructors

Constructor	Description
IOInputStream(IRubyObject io)	Creates a new InputStream with the object provided.
IOInputStream(IRubyObject io, boolean verifyCanRead)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

IOInputStream

public IOInputStream(IRubyObject io)

Creates a new InputStream with the object provided.

Parameters:

io - the ruby object

IOInputStream

public IOInputStream(IRubyObject io,
 boolean verifyCanRead)

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException