org.apache.james.imap.decode.parser

Class ListCommandParser

java.lang.Object

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

org.apache.james.imap.decode.parser.ListCommandParser

All Implemented Interfaces:

ImapCommandParser, MessagingImapCommandParser

Direct Known Subclasses:

LsubCommandParser, XListCommandParser

public class ListCommandParser
extends AbstractImapCommandParser

Parse LIST commands

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListCommandParser()
protected	ListCommandParser(ImapCommand command)

Method Summary

Methods

Modifier and Type	Method and Description
protected ImapMessage	createMessage(ImapCommand command, String referenceName, String mailboxPattern, String tag)
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)
String	listMailbox(ImapRequestLineReader request) Reads an argument of type "list_mailbox" from the request, which is the second argument for a LIST or LSUB command.

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

ListCommandParser

public ListCommandParser()

ListCommandParser

protected ListCommandParser(ImapCommand command)

Method Detail

listMailbox

public String listMailbox(ImapRequestLineReader request)
                   throws DecodingException

Reads an argument of type "list_mailbox" from the request, which is the second argument for a LIST or LSUB command. Valid values are a "string" argument, an "atom" with wildcard characters.

Returns:

An argument of type "list_mailbox"

Throws:

DecodingException

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)

createMessage

protected ImapMessage createMessage(ImapCommand command,
                        String referenceName,
                        String mailboxPattern,
                        String tag)

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