FileDocCategorySizeDatePackage
ToNetASCIIInputStream.javaAPI DocApache Commons NET 1.4.1 API4968Sat Dec 03 10:05:48 GMT 2005org.apache.commons.net.io

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

Fields Summary
private static final int
__NOTHING_SPECIAL
private static final int
__LAST_WAS_CR
private static final int
__LAST_WAS_NL
private int
__status
Constructors Summary
public ToNetASCIIInputStream(InputStream input)
Creates a ToNetASCIIInputStream instance that wraps an existing InputStream.

param
input The InputStream to .


                          
      
    
        super(input);
        __status = __NOTHING_SPECIAL;
Methods Summary
public intavailable()

        int result;

        result = in.available();

        if (__status == __LAST_WAS_NL)
            return (result + 1);

        return result;
public booleanmarkSupported()
Returns false. Mark is not supported.

        return false;
public intread()
Reads and returns the next byte in the stream. If the end of the message has been reached, returns -1.

return
The next character in the stream. Returns -1 if the end of the stream has been reached.
exception
IOException If an error occurs while reading the underlying stream.

        int ch;

        if (__status == __LAST_WAS_NL)
        {
            __status = __NOTHING_SPECIAL;
            return '\n";
        }

        ch = in.read();

        switch (ch)
        {
        case '\r":
            __status = __LAST_WAS_CR;
            return '\r";
        case '\n":
            if (__status != __LAST_WAS_CR)
            {
                __status = __LAST_WAS_NL;
                return '\r";
            }
            // else fall through
        default:
            __status = __NOTHING_SPECIAL;
            return ch;
        }
        // statement not reached
        //return ch;
public intread(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.

param
buffer The byte array in which to store the data.
return
The number of bytes read. Returns -1 if the end of the message has been reached.
exception
IOException If an error occurs in reading the underlying stream.

        return read(buffer, 0, buffer.length);
public 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. 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.

param
buffer The byte array in which to store the data.
param
offset The offset into the array at which to start storing data.
param
length The number of bytes to read.
return
The number of bytes read. Returns -1 if the end of the stream has been reached.
exception
IOException If an error occurs while reading the underlying stream.

        int ch, off;

        if (length < 1)
            return 0;

        ch = available();

        if (length > ch)
            length = ch;

        // If nothing is available, block to read only one character
        if (length < 1)
            length = 1;

        if ((ch = read()) == -1)
            return -1;

        off = offset;

        do
        {
            buffer[offset++] = (byte)ch;
        }
        while (--length > 0 && (ch = read()) != -1);

        return (offset - off);