ImapRequestLineReader (Apache James Protocols 1.6.3-SNAPSHOT API)

java.lang.Object
- org.apache.james.imap.decode.ImapRequestLineReader

Direct Known Subclasses:

IMAPRequestLineReader
```
public abstract class ImapRequestLineReader
extends Object
```
Wraps the client input reader with a bunch of convenience methods, allowing lookahead=1 on the underlying character stream. TODO need to look at encoding

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImapRequestLineReader.ATOM_CHARValidator`
`static interface`	`ImapRequestLineReader.CharacterValidator` Provides the ability to ensure characters are part of a permitted set.
`static class`	`ImapRequestLineReader.MessageSetCharValidator`
`static class`	`ImapRequestLineReader.NoopCharValidator`
`static class`	`ImapRequestLineReader.TagCharValidator`

Field Summary

Fields
Modifier and Type Field and Description

protected char nextChar

protected boolean nextSeen

Fields
Modifier and Type	Field and Description
`protected char`	`nextChar`
`protected boolean`	`nextSeen`

Constructor Summary

Constructors
Constructor and Description

ImapRequestLineReader()

Constructors
Constructor and Description
`ImapRequestLineReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`astring()` Reads an argument of type "astring" from the request.
`String`	`astring(Charset charset)` Reads an argument of type "astring" from the request.
`String`	`atom()` Reads an argument of type "atom" from the request.
`static int`	`cap(char next)`
`protected abstract void`	`commandContinuationRequest()` Sends a server command continuation request '+' back to the client, requesting more data to be sent.
`char`	`consume()` Consumes the current character in the reader, so that subsequent calls to the request will provide a new character.
`void`	`consumeChar(char expected)` Consumes the next character in the request, checking that it matches the expected one.
`void`	`consumeLine()` Consume the rest of the line
`InputStream`	`consumeLiteral(boolean extraCRLF)`
`String`	`consumeLiteral(Charset charset)` Reads an argument of type "literal" from the request, in the format: "{" charCount "}" CRLF *CHAR8 Note before calling, the request should be positioned so that nextChar is '{'.
`String`	`consumeQuoted()` Reads a quoted string value from the request.
`protected String`	`consumeQuoted(Charset charset)` Reads a quoted string value from the request.
`String`	`consumeWord(ImapRequestLineReader.CharacterValidator validator)` Reads the next "word from the request, comprising all characters up to the next SPACE.
`DayMonthYear`	`date()` Reads one `date` argument from the request.
`Date`	`dateTime()` Reads a "date-time" argument from the request.
`void`	`eol()` Moves the request line reader to end of the line, checking that no non-space character are found.
`javax.mail.Flags`	`flag()` Reads a "flag" argument from the request.
`javax.mail.Flags`	`flagList()` Reads a "flags-list" argument from the request.
`static boolean`	`isCHAR(char chr)`
`static boolean`	`isListWildcard(char chr)`
`static boolean`	`isQuotedSpecial(char chr)`
`String`	`mailbox()` Reads the mailbox name via `mailboxUTF7()` but also decode it via `CharsetUtil.decodeModifiedUTF7(String)` If you really want to get the modified UTF7 version you should use `mailboxUTF7()`
`String`	`mailboxUTF7()` Reads a "mailbox" argument from the request.
`abstract char`	`nextChar()` Reads the next character in the current line.
`char`	`nextWordChar()` Reads the next regular, non-space character in the current line.
`String`	`nstring()` Reads an argument of type "nstring" from the request.
`long`	`number()` Calls `number()` with argument of false
`long`	`number(boolean stopOnParen)` Reads an argument of type "number" from the request
`long`	`nzNumber()` Reads an argument of type "nznumber" (a non-zero number) (NOTE this isn't strictly as per the spec, since the spec disallows numbers such as "0123" as nzNumbers (although it's ok as a "number".
`IdRange[]`	`parseIdRange()` Reads a "message set" argument, and parses into an IdSet.
`IdRange[]`	`parseIdRange(ImapSession session)` Reads a "message set" argument, and parses into an IdSet.
`abstract InputStream`	`read(int size, boolean extraCRLF)` Reads and consumes a number of characters from the underlying reader, filling the char array provided.
`String`	`tag()` Reads a command "tag" from the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - nextSeen
```
protected boolean nextSeen
```
  - nextChar
```
protected char nextChar
```
- Constructor Detail
  - ImapRequestLineReader
```
public ImapRequestLineReader()
```
- Method Detail
  - cap
```
public static int cap(char next)
```
  - nextWordChar
```
public char nextWordChar()
                  throws DecodingException
```
    Reads the next regular, non-space character in the current line. Spaces are skipped over, but end-of-line characters will cause a DecodingException to be thrown. This method will continue to return the same character until the consume() method is called.
    
    Returns:
    The next non-space character.
    
    Throws:
    
    DecodingException - If the end-of-line or end-of-stream is reached.
  - nextChar
```
public abstract char nextChar()
                       throws DecodingException
```
    Reads the next character in the current line. This method will continue to return the same character until the consume() method is called.
    
    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.
  - eol
```
public void eol()
         throws DecodingException
```
    Moves the request line reader to end of the line, checking that no non-space character are found.
    
    Throws:
    
    DecodingException - If more non-space tokens are found in this line, or the end-of-file is reached.
  - consume
```
public char consume()
             throws DecodingException
```
    Consumes the current character in the reader, so that subsequent calls to the request will provide a new character. This method does *not* read the new character, or check if such a character exists. If no current character has been seen, the method moves to the next character, consumes it, and moves on to the subsequent one.
    
    Throws:
    
    DecodingException - if a the current character can't be obtained (eg we're at end-of-file).
  - read
```
public abstract InputStream read(int size,
               boolean extraCRLF)
                          throws DecodingException
```
    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;
    
    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 abstract void commandContinuationRequest()
                                            throws DecodingException
```
    Sends a server command continuation request '+' back to the client, requesting more data to be sent.
    
    Throws:
    
    DecodingException
  - consumeLine
```
public void consumeLine()
                 throws DecodingException
```
    Consume the rest of the line
    
    Throws:
    
    DecodingException
  - atom
```
public String atom()
            throws DecodingException
```
    Reads an argument of type "atom" from the request.
    
    Throws:
    
    DecodingException
  - tag
```
public String tag()
           throws DecodingException
```
    Reads a command "tag" from the request.
    
    Throws:
    
    DecodingException
  - astring
```
public String astring()
               throws DecodingException
```
    Reads an argument of type "astring" from the request.
    
    Throws:
    
    DecodingException
  - astring
```
public String astring(Charset charset)
               throws DecodingException
```
    Reads an argument of type "astring" from the request.
    
    Throws:
    
    DecodingException
  - nstring
```
public String nstring()
               throws DecodingException
```
    Reads an argument of type "nstring" from the request.
    
    Throws:
    
    DecodingException
  - mailbox
```
public String mailbox()
               throws DecodingException
```
    Reads the mailbox name via mailboxUTF7() but also decode it via CharsetUtil.decodeModifiedUTF7(String) If you really want to get the modified UTF7 version you should use mailboxUTF7()
    
    Returns:
    decodedMailbox
    
    Throws:
    
    DecodingException
  - mailboxUTF7
```
public String mailboxUTF7()
                   throws DecodingException
```
    Reads a "mailbox" argument from the request. Not implemented *exactly* as per spec, since a quoted or literal "inbox" still yeilds "INBOX" (ie still case-insensitive if quoted or literal). I think this makes sense. mailbox ::= "INBOX" / astring ;; INBOX is case-insensitive. All case variants of ;; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX ;; not as an astring. Be aware that mailbox names are encoded via a modified UTF7. For more informations RFC3501
    
    Throws:
    
    DecodingException
  - date
```
public DayMonthYear date()
                  throws DecodingException
```
    Reads one date argument from the request.
    
    Returns:
    DayMonthYear, not null
    
    Throws:
    
    DecodingException
  - dateTime
```
public Date dateTime()
              throws DecodingException
```
    Reads a "date-time" argument from the request.
    
    Throws:
    
    DecodingException
  - consumeWord
```
public String consumeWord(ImapRequestLineReader.CharacterValidator validator)
                   throws DecodingException
```
    Reads the next "word from the request, comprising all characters up to the next SPACE. Characters are tested by the supplied CharacterValidator, and an exception is thrown if invalid characters are encountered.
    
    Throws:
    
    DecodingException
  - consumeLiteral
```
public String consumeLiteral(Charset charset)
                      throws DecodingException
```
    Reads an argument of type "literal" from the request, in the format: "{" charCount "}" CRLF *CHAR8 Note before calling, the request should be positioned so that nextChar is '{'. Leading whitespace is not skipped in this method.
    
    Parameters:
    charset - , or null for US-ASCII
    
    Throws:
    
    DecodingException
  - consumeLiteral
```
public InputStream consumeLiteral(boolean extraCRLF)
                           throws DecodingException
```
    Throws:
    
    DecodingException
  - consumeChar
```
public void consumeChar(char expected)
                 throws DecodingException
```
    Consumes the next character in the request, checking that it matches the expected one. This method should be used when the
    
    Throws:
    
    DecodingException
  - consumeQuoted
```
public String consumeQuoted()
                     throws DecodingException
```
    Reads a quoted string value from the request.
    
    Throws:
    
    DecodingException
  - consumeQuoted
```
protected String consumeQuoted(Charset charset)
                        throws DecodingException
```
    Reads a quoted string value from the request.
    
    Throws:
    
    DecodingException
  - flagList
```
public javax.mail.Flags flagList()
                          throws DecodingException
```
    Reads a "flags-list" argument from the request.
    
    Throws:
    
    DecodingException
  - flag
```
public javax.mail.Flags flag()
                      throws DecodingException
```
    Reads a "flag" argument from the request.
    
    Throws:
    
    DecodingException
  - number
```
public long number()
            throws DecodingException
```
    Calls number() with argument of false
    
    Returns:
    number
    
    Throws:
    
    DecodingException
  - number
```
public long number(boolean stopOnParen)
            throws DecodingException
```
    Reads an argument of type "number" from the request
    
    Parameters:
    stopOnParen - true if it should stop to parse on the first closing paren
    
    Returns:
    number
    
    Throws:
    
    DecodingException
  - nzNumber
```
public long nzNumber()
              throws DecodingException
```
    Reads an argument of type "nznumber" (a non-zero number) (NOTE this isn't strictly as per the spec, since the spec disallows numbers such as "0123" as nzNumbers (although it's ok as a "number". I think the spec is a bit shonky.)
    
    Throws:
    
    DecodingException
  - isCHAR
```
public static boolean isCHAR(char chr)
```
  - isListWildcard
```
public static boolean isListWildcard(char chr)
```
  - isQuotedSpecial
```
public static boolean isQuotedSpecial(char chr)
```
  - parseIdRange
```
public IdRange[] parseIdRange()
                       throws DecodingException
```
    Reads a "message set" argument, and parses into an IdSet.
    
    Throws:
    
    DecodingException
  - parseIdRange
```
public IdRange[] parseIdRange(ImapSession session)
                       throws DecodingException
```
    Reads a "message set" argument, and parses into an IdSet. This also support the use of $ as sequence-set as stated in SEARCHRES RFC5182
    
    Throws:
    
    DecodingException

Class ImapRequestLineReader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nextSeen

nextChar

Constructor Detail

ImapRequestLineReader

Method Detail

cap

nextWordChar

nextChar

eol

consume

read

commandContinuationRequest

consumeLine

atom

tag

astring

astring

nstring

mailbox

mailboxUTF7

date

dateTime

consumeWord

consumeLiteral

consumeLiteral

consumeChar

consumeQuoted

consumeQuoted

flagList

flag

number

number

nzNumber

isCHAR

isListWildcard

isQuotedSpecial

parseIdRange

parseIdRange