| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.io.Writer
org.apache.commons.net.io.DotTerminatedMessageWriter
public final class DotTerminatedMessageWriter
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.
| Field Summary | 
|---|
| Fields inherited from class java.io.Writer | 
|---|
| lock | 
| Constructor Summary | |
|---|---|
| DotTerminatedMessageWriter(Writer output)Creates a DotTerminatedMessageWriter that wraps an existing Writer output destination. | |
| Method Summary | |
|---|---|
|  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(String string)Writes a String to the output. | 
|  void | write(String string,
           int offset,
           int length)Writes part of a String to the output starting from a given offset. | 
| Methods inherited from class java.io.Writer | 
|---|
| append, append, append | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public DotTerminatedMessageWriter(Writer output)
output - The Writer output destination to write the message.| Method Detail | 
|---|
public void write(int ch)
           throws IOException
write in class Writerch - The character to write.
IOException - If an error occurs while writing to the
            underlying output.
public void write(char[] buffer,
                  int offset,
                  int length)
           throws IOException
write in class Writerbuffer - The character array to write.offset - The offset into the array at which to start copying data.length - The number of characters to write.
IOException - If an error occurs while writing to the underlying
            output.
public void write(char[] buffer)
           throws IOException
write in class Writerbuffer - The character array to write.
IOException - If an error occurs while writing to the underlying
            output.
public void write(String string)
           throws IOException
write in class Writerstring - The String to write.
IOException - If an error occurs while writing to the underlying
            output.
public void write(String string,
                  int offset,
                  int length)
           throws IOException
write in class Writerstring - The String to write.offset - The offset into the String at which to start copying data.length - The number of characters to write.
IOException - If an error occurs while writing to the underlying
            output.
public void flush()
           throws IOException
flush in interface Flushableflush in class WriterIOException - If an error occurs while writing to the underlying
            output.
public void close()
           throws IOException
close in interface Closeableclose in class WriterIOException - If an error occurs while writing to the underlying
            output or closing the Writer.| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||