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.

Author: Daniel F. Savarese

Constructor Summary
ToNetASCIIInputStream(InputStream input)
Creates a ToNetASCIIInputStream instance that wraps an existing InputStream.
Method Summary
intavailable()
booleanmarkSupported()
Returns false.
intread()
Reads and returns the next byte in the stream.
intread(byte[] buffer)
Reads the next number of bytes from the stream into an array and returns the number of bytes read.
intread(byte[] 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 Detail

ToNetASCIIInputStream

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

Parameters: input The InputStream to .

Method Detail

available

public int available()

markSupported

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

read

public int read()
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.

Throws: IOException If an error occurs while reading the underlying stream.

read

public int read(byte[] buffer)
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: buffer The byte array in which to store the data.

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

Throws: IOException If an error occurs in reading the underlying stream.

read

public int read(byte[] buffer, int offset, int length)
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: buffer The byte array in which to store the data. 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.

Throws: IOException If an error occurs while reading the underlying stream.