org.apache.commons.net.io

Class ToNetASCIIOutputStream

FilterOutputStream
|
+--org.apache.commons.net.io.ToNetASCIIOutputStream

public final class ToNetASCIIOutputStream
extends FilterOutputStream

This class wraps an output stream, replacing all singly occurring <LF> (linefeed) characters with <CR><LF> (carriage return followed by linefeed), which is the NETASCII standard for representing a newline. You would use this class to implement ASCII file transfers requiring conversion to NETASCII.

Author:

Daniel F. Savarese

Constructor Summary

ToNetASCIIOutputStream(OutputStream output)

Creates a ToNetASCIIOutputStream instance that wraps an existing OutputStream.

Method Summary

synchronized void

write(int ch)

Writes a byte to the stream.

synchronized void

write(byte[] buffer)

Writes a byte array to the stream.

synchronized void

write(byte[] buffer, int offset, int length)

Writes a number of bytes from a byte array to the stream starting from a given offset.

Constructor Details

ToNetASCIIOutputStream

public ToNetASCIIOutputStream(OutputStream output)

Creates a ToNetASCIIOutputStream instance that wraps an existing OutputStream.

output - The OutputStream to wrap.

Method Details

write

public synchronized void write(byte[] buffer)

Writes a byte array to the stream.

buffer - The byte array to write.

- If an error occurs while writing to the underlying stream.

write

public synchronized void write(byte[] buffer, int offset, int length)

Writes a number of bytes from a byte array to the stream starting from a given offset.

buffer - The byte array to write.
offset - The offset into the array at which to start copying data.
length - The number of bytes to write.

- If an error occurs while writing to the underlying stream.

write

public synchronized void write(int ch)

Writes a byte to the stream. Note that a call to this method may result in multiple writes to the underlying input stream in order to convert naked newlines to NETASCII line separators. This is transparent to the programmer and is only mentioned for completeness.

ch - The byte to write.

- If an error occurs while writing to the underlying stream.