com.github.robtimus.io.stream

Class AsciiInputStream

java.lang.Object

java.io.InputStream

com.github.robtimus.io.stream.AsciiInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class AsciiInputStream
extends InputStream

An input stream that wraps a reader that contains only ASCII characters. If the wrapped reader contains any non-ASCII characters, the wrapping AsciiInputStream will throw an IOException.

This can be used in code that expects an input stream where a reader is available. One such example is base64 decoding. Even though base64 is text, Base64.Decoder can only wrap InputStream. This method can help:

InputStream input = Base64.getDecoder().wrap(new AsciiInputStream(reader));

When an AsciiInputStream is closed, the wrapped reader will be closed as well.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
AsciiInputStream(Reader input) Creates a new ASCII input stream.

Method Summary

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

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

AsciiInputStream

public AsciiInputStream(Reader input)

Creates a new ASCII input stream.

Parameters:

input - The reader to wrap.

Throws:

NullPointerException - If the given reader is null.

Method Detail

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

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

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