|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.nntp.ArticleFilter
public class ArticleFilter
Filters article lists according to those that match the range, message id, or patterns passed to the filter. Used with commands like XOVER, XHDR, etc. A range can be:
Field Summary | |
---|---|
static int |
ALL
The filter will match all articles. |
static ArticleFilter |
ALL_ARTICLE_FILTER
A simple constant filter for current article filtering. |
static int |
CURRENT_ARTICLE
The filter matches the current article pointer article. |
static ArticleFilter |
CURRENT_ARTICLE_FILTER
A simple constant filter for current article filtering. |
static int |
MESSAGE_ID
The filter will match one article by message id. |
static int |
NUMBER
The filter will match one article by message number. |
static int |
OPEN_RANGE
The filter will match articles with numbers greater than or equal to the start index number. |
static int |
RANGE
The filter will match articles between the start and end index numbers. |
Constructor Summary | |
---|---|
ArticleFilter(java.lang.String range)
Create an article filter for the given article range. |
Method Summary | |
---|---|
int |
getArticleNumber()
Obtain the article number of the article this filter is looking for. |
int |
getEndIndex()
Obtain the second filter number, specifying the message end index if the mode RANGE. |
java.lang.String |
getMessageID()
Obtain the message ID of the article this filter is looking for. |
int |
getMode()
Returns the filter mode currently set. |
int |
getStartIndex()
Obtain the first filter number, specifying the message number if the mode is NUMBER, or the start index if the mode is OPEN_RANGE or RANGE. |
void |
setRange(java.lang.String range)
Sets the filter mode (mutually exclusive) to the given article number or message id range. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ALL
The filter will match all articles.
public static final int CURRENT_ARTICLE
The filter matches the current article pointer article.
public static final int MESSAGE_ID
The filter will match one article by message id.
public static final int NUMBER
The filter will match one article by message number.
public static final int RANGE
The filter will match articles between the start and end index numbers.
public static final int OPEN_RANGE
The filter will match articles with numbers greater than or equal to the start index number.
public static final ArticleFilter CURRENT_ARTICLE_FILTER
A simple constant filter for current article filtering.
public static final ArticleFilter ALL_ARTICLE_FILTER
A simple constant filter for current article filtering.
Constructor Detail |
---|
public ArticleFilter(java.lang.String range)
Create an article filter for the given article range.
range
- the article range to apply to this filter.Method Detail |
---|
public int getMode()
Returns the filter mode currently set.
public void setRange(java.lang.String range)
Sets the filter mode (mutually exclusive) to the given article number or message id range.
range
- the range (number, number-, number-number, <messageid>).public java.lang.String getMessageID() throws java.lang.IllegalStateException
Obtain the message ID of the article this filter is looking for. The returned string is only valid if the mode is equal to MESSAGE_ID.
java.lang.IllegalStateException
- if the parameter is not relevant to the
current filter mode..public int getArticleNumber() throws java.lang.IllegalStateException
Obtain the article number of the article this filter is looking for. The returned number is only valid if the mode is equal to NUMBER.
java.lang.IllegalStateException
- if the parameter is not relevant to the
current filter mode.public int getStartIndex() throws java.lang.IllegalStateException
Obtain the first filter number, specifying the message number if the mode is NUMBER, or the start index if the mode is OPEN_RANGE or RANGE.
java.lang.IllegalStateException
- if the parameter is not relevant to the
current filter mode.public int getEndIndex() throws java.lang.IllegalStateException
Obtain the second filter number, specifying the message end index if the mode RANGE.
java.lang.IllegalStateException
- if the parameter is not relevant to the
current filter mode.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |