aria.apache.commons.net.io

类 DotTerminatedMessageWriter

java.lang.Object

java.io.Writer

aria.apache.commons.net.io.DotTerminatedMessageWriter

所有已实现的接口:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public final class DotTerminatedMessageWriter
extends java.io.Writer

DotTerminatedMessageWriter is a class used to write messages to 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 the doubling of line-starting periods, converts single linefeeds to NETASCII newlines, and on closing will send the final message terminator dot and NETASCII newline sequence.

字段概要

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

lock

构造器概要

构造器

构造器和说明
DotTerminatedMessageWriter(java.io.Writer output) Creates a DotTerminatedMessageWriter that wraps an existing Writer output destination.

方法概要

限定符和类型	方法和说明
void	close() Flushes the underlying output, writing all buffered output, but doesn't actually close the underlying stream.
void	flush() Flushes the underlying output, writing all buffered output.
void	write(char[] buffer) Writes a character array to the output.
void	write(char[] buffer, int offset, int length) Writes a number of characters from a character array to the output starting from a given offset.
void	write(int ch) Writes a character to the output.
void	write(java.lang.String string) Writes a String to the output.
void	write(java.lang.String string, int offset, int length) Writes part of a String to the output starting from a given offset.

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

append, append, append

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

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

构造器详细资料

DotTerminatedMessageWriter

public DotTerminatedMessageWriter(java.io.Writer output)

Creates a DotTerminatedMessageWriter that wraps an existing Writer output destination.

参数:

output - The Writer output destination to write the message.

方法详细资料

write

public void write(int ch)
           throws java.io.IOException

Writes a character to the output. Note that a call to this method may result in multiple writes to the underling Writer in order to convert naked linefeeds to NETASCII line separators and to double line-leading periods. This is transparent to the programmer and is only mentioned for completeness.

覆盖:

write 在类中 java.io.Writer

参数:

ch - The character to write.

抛出:

java.io.IOException - If an error occurs while writing to the underlying output.

write

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

Writes a number of characters from a character array to the output starting from a given offset.

指定者:

write 在类中 java.io.Writer

参数:

buffer - The character array to write.

offset - The offset into the array at which to start copying data.

length - The number of characters to write.

抛出:

java.io.IOException - If an error occurs while writing to the underlying output.

write

public void write(char[] buffer)
           throws java.io.IOException

Writes a character array to the output.

覆盖:

write 在类中 java.io.Writer

参数:

buffer - The character array to write.

抛出:

java.io.IOException - If an error occurs while writing to the underlying output.

write

public void write(java.lang.String string)
           throws java.io.IOException

Writes a String to the output.

覆盖:

write 在类中 java.io.Writer

参数:

string - The String to write.

抛出:

java.io.IOException - If an error occurs while writing to the underlying output.

write

public void write(java.lang.String string,
                  int offset,
                  int length)
           throws java.io.IOException

Writes part of a String to the output starting from a given offset.

覆盖:

write 在类中 java.io.Writer

参数:

string - The String to write.

offset - The offset into the String at which to start copying data.

length - The number of characters to write.

抛出:

java.io.IOException - If an error occurs while writing to the underlying output.

flush

public void flush()
           throws java.io.IOException

Flushes the underlying output, writing all buffered output.

指定者:

flush 在接口中 java.io.Flushable

指定者:

flush 在类中 java.io.Writer

抛出:

java.io.IOException - If an error occurs while writing to the underlying output.

close

public void close()
           throws java.io.IOException

Flushes the underlying output, writing all buffered output, but doesn't actually close the underlying stream. The underlying stream may still be used for communicating with the server and therefore is not closed.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

指定者:

close 在类中 java.io.Writer

抛出:

java.io.IOException - If an error occurs while writing to the underlying output or closing the Writer.