org.apache.commons.net.io

Class DotTerminatedMessageWriter


public final class DotTerminatedMessageWriter
extends 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.

Constructor Summary

DotTerminatedMessageWriter(Writer output)
Creates a DotTerminatedMessageWriter that wraps an existing Writer output destination.

Method Summary

@Override
void close()
Flushes the underlying output, writing all buffered output, but doesn't actually close the underlying stream.
@Override
void flush()
Flushes the underlying output, writing all buffered output.
@Override
void write(String string)
Writes a String to the output.
@Override
void write(String string, int offset, int length)
Writes part of a String to the output starting from a given offset.
@Override
void write(char[] buffer)
Writes a character array to the output.
@Override
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.
@Override
void write(int ch)
Writes a character to the output.

Constructor Details

DotTerminatedMessageWriter

public DotTerminatedMessageWriter(Writer output)
Creates a DotTerminatedMessageWriter that wraps an existing Writer output destination.

Parameters:
output - The Writer output destination to write the message.

Method Details

void close

public @Override void close()
            throws 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.


void flush

public @Override void flush()
            throws IOException
Flushes the underlying output, writing all buffered output.


void write

public @Override void write(String string)
            throws IOException
Writes a String to the output.

Parameters:
string - The String to write.

void write

public @Override void write(String string,
                            int offset,
                            int length)
            throws IOException
Writes part of a String to the output starting from a given offset.

Parameters:
string - The String to write.
offset - The offset into the String at which to start copying data.
length - The number of characters to write.

void write

public @Override void write(char[] buffer)
            throws IOException
Writes a character array to the output.

Parameters:
buffer - The character array to write.

void write

public @Override void write(char[] buffer,
                            int offset,
                            int length)
            throws IOException
Writes a number of characters from a character array to the output starting from a given offset.

Parameters:
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.

void write

public @Override void write(int ch)
            throws 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.

Parameters:
ch - The character to write.