com.jivesoftware.forum.nntp
Class ArticleCommand

java.lang.Object
  com.jivesoftware.forum.nntp.ArticleCommand

public class ArticleCommand
extends java.lang.Object

Obtains an article command from it's string parts and selects the correct article based on the command.

Method Summary

Article	getArticle() Obtain the article retrieved by the command.
static ArticleCommand	getCommand(java.lang.String[] cmdParts, ArticlePointer pointer) Obtain a command based on the given command strings (NNTP protocol) and current pointer location.
java.lang.String	getMessageID() Obtain the Message-ID used to retrieve the article or null if not used.
long	getNumber() Obtain the number used to retrieve the article or -1 if no number was used.

Methods inherited from class java.lang.Object

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

Method Detail

getCommand

public static ArticleCommand getCommand(java.lang.String[] cmdParts,
                                        ArticlePointer pointer)
                                 throws ArticleNotFoundException,
                                        NoGroupSelectedException,
                                        NoPermissionException,
                                        ArticleNotSelectedException

Obtain a command based on the given command strings (NNTP protocol) and current pointer location.

Parameters:

cmdParts - the command line broken into tokens around whitespace.

pointer - the article pointer for the active session.

Returns:

the article command parsed from the command.

Throws:

ArticleNotFoundException - if the indicated article could not be found.

NoGroupSelectedException - if no group was selected and a number command was issued.

NoPermissionException - if the caller does not have permission to access the article.

ArticleNotSelectedException - if no current article is selected.

getArticle

public Article getArticle()

Obtain the article retrieved by the command.

Returns:

the article resulting from the command.

getNumber

public long getNumber()

Obtain the number used to retrieve the article or -1 if no number was used.

Returns:

the article resulting from the command.

getMessageID

public java.lang.String getMessageID()

Obtain the Message-ID used to retrieve the article or null if not used.

Returns:

the article resulting from the command.