aria.apache.commons.net.io

类 DotTerminatedMessageReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

aria.apache.commons.net.io.DotTerminatedMessageReader

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public final class DotTerminatedMessageReader
extends java.io.BufferedReader

DotTerminatedMessageReader is a class used to read messages from a server that are terminated by a single dot followed by a <CR><LF> sequence and with double dots appearing at the begining of lines which do not signal end of message yet start with a dot. Various Internet protocols such as NNTP and POP3 produce messages of this type.

This class handles stripping of the duplicate period at the beginning of lines starting with a period, and ensures you cannot read past the end of the message.

Note: versions since 3.0 extend BufferedReader rather than Reader, and no longer change the CRLF into the local EOL. Also only DOT CR LF acts as EOF.

字段概要

从类继承的字段 java.io.Reader

lock

构造器概要

构造器

构造器和说明
DotTerminatedMessageReader(java.io.Reader reader) Creates a DotTerminatedMessageReader that wraps an existing Reader input source.

方法概要

限定符和类型	方法和说明
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.
java.lang.String	readLine() Read a line of text.

从类继承的方法 java.io.BufferedReader

lines, mark, markSupported, ready, reset, skip

从类继承的方法 java.io.Reader

read

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DotTerminatedMessageReader

public DotTerminatedMessageReader(java.io.Reader reader)

Creates a DotTerminatedMessageReader that wraps an existing Reader input source.

参数:

reader - The Reader input source containing the message.

方法详细资料

read

public int read()
         throws java.io.IOException

Reads and returns the next character in the message. If the end of the message has been reached, returns -1. Note that a call to this method may result in multiple reads from the underlying input stream to decode the message properly (removing doubled dots and so on). All of this is transparent to the programmer and is only mentioned for completeness.

覆盖:

read 在类中 java.io.BufferedReader

返回:

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

抛出:

java.io.IOException - If an error occurs while reading the underlying stream.

read

public int read(char[] buffer)
         throws java.io.IOException

Reads the next characters from the message into an array and returns the number of characters read. Returns -1 if the end of the message has been reached.

覆盖:

read 在类中 java.io.Reader

参数:

buffer - The character array in which to store the characters.

返回:

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

抛出:

java.io.IOException - If an error occurs in reading the underlying stream.

read

public int read(char[] buffer,
                int offset,
                int length)
         throws java.io.IOException

Reads the next characters from the message into an array and returns the number of characters 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.

覆盖:

read 在类中 java.io.BufferedReader

参数:

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.

返回:

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

抛出:

java.io.IOException - If an error occurs in reading the underlying stream.

close

public void close()
           throws java.io.IOException

Closes the message for reading. This doesn't actually close the underlying stream. The underlying stream may still be used for communicating with the server and therefore is not closed.

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.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

覆盖:

close 在类中 java.io.BufferedReader

抛出:

java.io.IOException - If an error occurs while reading the underlying stream.

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Read a line of text. A line is considered to be terminated by carriage return followed immediately by a linefeed. This contrasts with BufferedReader which also allows other combinations.

覆盖:

readLine 在类中 java.io.BufferedReader

抛出:

java.io.IOException

从以下版本开始:

3.0