org.apache.commons.net.io

Class ToNetASCIIInputStream


public final class ToNetASCIIInputStream
extends FilterInputStream

This class wraps an input 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

ToNetASCIIInputStream(InputStream input)
Creates a ToNetASCIIInputStream instance that wraps an existing InputStream.

Method Summary

@Override
boolean markSupported()
Returns false.
@Override
int available()
@Override
int read()
Reads and returns the next byte in the stream.
@Override
int read(buffer[] )
Reads the next number of bytes from the stream into an array and returns the number of bytes read.
@Override
int read(buffer[] , int offset, int length)
Reads the next number of bytes from the stream into an array and returns the number of bytes read.

Constructor Details

ToNetASCIIInputStream

public ToNetASCIIInputStream(InputStream input)
Creates a ToNetASCIIInputStream instance that wraps an existing InputStream.

Parameters:
input - The InputStream to .

Method Details

boolean markSupported

public @Override boolean markSupported()
Returns false. Mark is not supported. **

int available

public @Override int available()
            throws IOException

int read

public @Override int read()
            throws IOException
Reads and returns the next byte in the stream. If the end of the message has been reached, returns -1.

Returns:
The next character in the stream. Returns -1 if the end of the stream has been reached.

int read

public @Override int read(buffer[] )
            throws IOException
Reads the next number of bytes from the stream into an array and returns the number of bytes read. Returns -1 if the end of the stream has been reached.

Parameters:
Returns:
The number of bytes read. Returns -1 if the end of the message has been reached.

int read

public @Override int read(buffer[] ,
                          int offset,
                          int length)
            throws IOException
Reads the next number of bytes from the stream into an array and returns the number of bytes read. Returns -1 if the end of the message has been reached. The characters are stored in the array starting from the given offset and up to the length specified.

Parameters:
offset - The offset into the array at which to start storing data.
length - The number of bytes to read.
Returns:
The number of bytes read. Returns -1 if the end of the stream has been reached.