org.apache.commons.net.io

Class 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.

Constructor Summary

ToNetASCIIOutputStream(OutputStream output)
Creates a ToNetASCIIOutputStream instance that wraps an existing OutputStream.

Method Summary

@Override
void write(buffer[] )
Writes a byte array to the stream.
@Override
void write(buffer[] , int offset, int length)
Writes a number of bytes from a byte array to the stream starting from a given offset.
@Override
void write(int ch)
Writes a byte to the stream.

Constructor Details

ToNetASCIIOutputStream

public ToNetASCIIOutputStream(OutputStream output)
Creates a ToNetASCIIOutputStream instance that wraps an existing OutputStream.

Parameters:
output - The OutputStream to wrap.

Method Details

void write

public @Override void write(buffer[] )
            throws IOException
Writes a byte array to the stream.

Parameters:

void write

public @Override void write(buffer[] ,
                            int offset,
                            int length)
            throws IOException
Writes a number of bytes from a byte array to the stream starting from a given offset.

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

void write

public @Override void write(int ch)
            throws IOException
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.

Parameters:
ch - The byte to write.