org.apache.james.imap.decode.parser

Class SearchCommandParser

java.lang.Object

org.apache.james.imap.decode.base.AbstractImapCommandParser

org.apache.james.imap.decode.parser.SearchCommandParser

All Implemented Interfaces:

ImapCommandParser, MessagingImapCommandParser

public class SearchCommandParser
extends AbstractImapCommandParser

Parse SEARCH commands

Constructor Summary

Constructors

Constructor and Description
SearchCommandParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected ImapMessage	decode(ImapCommand command, ImapRequestLineReader request, String tag, boolean useUids, ImapSession session)
protected ImapMessage	decode(ImapCommand command, ImapRequestLineReader request, String tag, ImapSession session) Parses a request into a command message for later processing.
ImapMessage	decode(ImapRequestLineReader request, String tag, boolean useUids, ImapSession session)
SearchKey	decode(ImapSession session, ImapRequestLineReader request)
protected SearchKey	searchKey(ImapSession session, ImapRequestLineReader request, Charset charset, boolean isFirstToken) Parses the request argument into a valid search term.

Methods inherited from class org.apache.james.imap.decode.base.AbstractImapCommandParser

getCommand, getStatusResponseFactory, parse, setStatusResponseFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCommandParser

public SearchCommandParser()

Method Detail

searchKey

protected SearchKey searchKey(ImapSession session,
                  ImapRequestLineReader request,
                  Charset charset,
                  boolean isFirstToken)
                       throws DecodingException,
                              IllegalCharsetNameException,
                              UnsupportedCharsetException

Parses the request argument into a valid search term.

Parameters:

request - ImapRequestLineReader, not null

charset - Charset or null if there is no charset

isFirstToken - true when this is the first token read, false otherwise

Throws:

DecodingException

IllegalCharsetNameException

UnsupportedCharsetException

decode

public SearchKey decode(ImapSession session,
               ImapRequestLineReader request)
                 throws DecodingException,
                        IllegalCharsetNameException,
                        UnsupportedCharsetException

Throws:

DecodingException

IllegalCharsetNameException

UnsupportedCharsetException

decode

protected ImapMessage decode(ImapCommand command,
                 ImapRequestLineReader request,
                 String tag,
                 boolean useUids,
                 ImapSession session)
                      throws DecodingException

Throws:

DecodingException

See Also:

AbstractUidCommandParser.decode(org.apache.james.imap.api.ImapCommand, org.apache.james.imap.decode.ImapRequestLineReader, java.lang.String, boolean, org.apache.james.imap.api.process.ImapSession)

decode

protected ImapMessage decode(ImapCommand command,
                 ImapRequestLineReader request,
                 String tag,
                 ImapSession session)
                      throws DecodingException

Description copied from class: AbstractImapCommandParser

Parses a request into a command message for later processing.

Specified by:

decode in class AbstractImapCommandParser

Parameters:

command - ImapCommand to be parsed, not null

request - ImapRequestLineReader, not null

tag - command tag, not null

session - imap session

Returns:

ImapCommandMessage, not null

Throws:

DecodingException - if the request cannot be parsed

decode

public ImapMessage decode(ImapRequestLineReader request,
                 String tag,
                 boolean useUids,
                 ImapSession session)
                   throws DecodingException

Throws:

DecodingException