org.apache.commons.net.io
public final class DotTerminatedMessageReader extends Reader
This class handles stripping of the duplicate period at the beginning of lines starting with a period, converts NETASCII newlines to the local line separator format, truncates the end of message indicator, and ensures you cannot read past the end of the message.
Version: $Id: DotTerminatedMessageReader.java 165675 2005-05-02 20:09:55Z rwinston $
Constructor Summary | |
---|---|
DotTerminatedMessageReader(Reader reader)
Creates a DotTerminatedMessageReader that wraps an existing Reader
input source. |
Method Summary | |
---|---|
void | close()
Closes the message for reading. |
int | read()
Reads and returns the next character in the message. |
int | read(char[] buffer)
Reads the next characters from the message into an array and
returns the number of characters read. |
int | read(char[] buffer, int offset, int length)
Reads the next characters from the message into an array and
returns the number of characters read. |
boolean | ready()
Determines if the message is ready to be read. |
Parameters: reader The Reader input source containing the message.
If the end of the message has not yet been reached, this method will read the remainder of the message until it reaches the end, so that the underlying stream may continue to be used properly for communicating with the server. If you do not fully read a message, you MUST close it, otherwise your program will likely hang or behave improperly.
Throws: IOException If an error occurs while reading the underlying stream.
Returns: The next character in the message. Returns -1 if the end of the message has been reached.
Throws: IOException If an error occurs while reading the underlying stream.
Parameters: buffer The character array in which to store the characters.
Returns: The number of characters read. Returns -1 if the end of the message has been reached.
Throws: IOException If an error occurs in reading the underlying stream.
Parameters: buffer The character array in which to store the characters. offset The offset into the array at which to start storing characters. length The number of characters to read.
Returns: The number of characters read. Returns -1 if the end of the message has been reached.
Throws: IOException If an error occurs in reading the underlying stream.
Returns: True if the message is ready to be read, false if not.
Throws: IOException If an error occurs while checking the underlying stream.