org.spf4j.io

Class ReaderInputStream

java.lang.Object

java.io.InputStream

org.spf4j.io.ReaderInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@Beta
public final class ReaderInputStream
extends InputStream

An InputStream that converts characters from a Reader into bytes using an arbitrary Charset.

This is an alternative to copying the data to an OutputStream via a Writer, which is necessarily blocking. By implementing an InputStream it allows consumers to "pull" as much data as they can handle, which is more convenient when dealing with flow controlled, async APIs.

Author:

Chris Nokleberg Notes by Z: THis class in its current state is not ready for prime time. Here is why: 1) Since it buffers, there needs to be capability to access the unconsumed bytes/chars. 2) Buffer sizing could be smarter? char buffer and byte buffers are not "byte size equivalent"(just made this up :-))

Constructor Summary

Constructors

Constructor and Description
ReaderInputStream(Reader reader, CharsetEncoder encoder, int bufferSize) Creates a new input stream that will encode the characters from reader into bytes using the given character set encoder.
ReaderInputStream(Reader reader, Charset charset, int bufferSize) Creates a new input stream that will encode the characters from reader into bytes using the given character set.

Method Summary

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

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderInputStream

public ReaderInputStream(Reader reader,
                         Charset charset,
                         int bufferSize)

Creates a new input stream that will encode the characters from reader into bytes using the given character set. Malformed input and unmappable characters will be replaced.

Parameters:

reader - input source

charset - character set used for encoding chars to bytes

bufferSize - size of internal input and output buffers

Throws:

IllegalArgumentException - if bufferSize is non-positive

ReaderInputStream

public ReaderInputStream(Reader reader,
                         CharsetEncoder encoder,
                         int bufferSize)

Creates a new input stream that will encode the characters from reader into bytes using the given character set encoder.

Parameters:

reader - input source

encoder - character set encoder used for encoding chars to bytes

bufferSize - size of internal input and output buffers

Throws:

IllegalArgumentException - if bufferSize is non-positive

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close 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,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object