com.github.robtimus.io.stream

Class AsciiOutputStream

java.lang.Object

java.io.OutputStream

com.github.robtimus.io.stream.AsciiOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class AsciiOutputStream
extends OutputStream

An output stream that wraps a writer to write only ASCII characters. If any non-ASCII bytes are written to an AsciiOutputStream, it will thrown an IOException.

This can be used in code that expects an output stream where a writer is available. One such example is base64 encoding. Even though base64 is text, Base64.Encoder can only wrap OutputStream. This method can help:

OutputStream output = Base64.getEncoder().wrap(new AsciiOutputStream(writer));

When an AsciiOutputStream is closed, the wrapped writer will be closed as well.

Author:

Rob Spoor

Constructor Summary

Constructors

Constructor and Description
AsciiOutputStream(Writer output) Creates a new ASCII output stream.

Method Summary

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

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

AsciiOutputStream

public AsciiOutputStream(Writer output)

Creates a new ASCII output stream.

Parameters:

output - The writer to wrap.

Throws:

NullPointerException - If the given writer is null.

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException