org.apache.james.protocols.imap

Class IMAPRequestLineReader

java.lang.Object

org.apache.james.imap.decode.ImapRequestLineReader

org.apache.james.protocols.imap.IMAPRequestLineReader

public class IMAPRequestLineReader
extends ImapRequestLineReader

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.james.imap.decode.ImapRequestLineReader

ImapRequestLineReader.ATOM_CHARValidator, ImapRequestLineReader.CharacterValidator, ImapRequestLineReader.MessageSetCharValidator, ImapRequestLineReader.NoopCharValidator, ImapRequestLineReader.TagCharValidator

Field Summary

Fields inherited from class org.apache.james.imap.decode.ImapRequestLineReader

nextChar, nextSeen

Constructor Summary

Constructors

Constructor and Description
IMAPRequestLineReader(IMAPRequest request)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	commandContinuationRequest() Sends a server command continuation request '+' back to the client, requesting more data to be sent.
char	nextChar() Reads the next character in the current line.
InputStream	read(int size, boolean extraCRLF) Reads and consumes a number of characters from the underlying reader, filling the char array provided.

Methods inherited from class org.apache.james.imap.decode.ImapRequestLineReader

astring, astring, atom, cap, consume, consumeChar, consumeLine, consumeLiteral, consumeLiteral, consumeQuoted, consumeQuoted, consumeWord, date, dateTime, eol, flag, flagList, isCHAR, isListWildcard, isQuotedSpecial, mailbox, mailboxUTF7, nextWordChar, nstring, number, number, nzNumber, parseIdRange, parseIdRange, tag

Methods inherited from class java.lang.Object

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

Constructor Detail

IMAPRequestLineReader

public IMAPRequestLineReader(IMAPRequest request)
                      throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

Method Detail

nextChar

public char nextChar()
              throws DecodingException

Description copied from class: ImapRequestLineReader

Reads the next character in the current line. This method will continue to return the same character until the ImapRequestLineReader.consume() method is called.

Specified by:

nextChar in class ImapRequestLineReader

Returns:

The next character TODO: character encoding is variable and cannot be determine at the token level; this char is not accurate reported; should be an octet

Throws:

DecodingException - If the end-of-stream is reached.

read

public InputStream read(int size,
               boolean extraCRLF)
                 throws DecodingException

Description copied from class: ImapRequestLineReader

Reads and consumes a number of characters from the underlying reader, filling the char array provided. TODO: remove unnecessary copying of bits; line reader should maintain an internal ByteBuffer;

Specified by:

read in class ImapRequestLineReader

Parameters:

size - count of characters to read and consume

extraCRLF - true if extra CRLF is wanted, false else

Throws:

DecodingException - If a char can't be read into each array element.

commandContinuationRequest

protected void commandContinuationRequest()
                                   throws DecodingException

Description copied from class: ImapRequestLineReader

Sends a server command continuation request '+' back to the client, requesting more data to be sent.

Specified by:

commandContinuationRequest in class ImapRequestLineReader

Throws:

DecodingException