|
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
com.jivesoftware.forum.nntp.ArticleHeaderFilter
public class ArticleHeaderFilter
Filters article lists according normal range filtering plus header wildmat pattern matching.
Field Summary |
---|
Fields inherited from class com.jivesoftware.forum.nntp.ArticleFilter |
---|
ALL, ALL_ARTICLE_FILTER, CURRENT_ARTICLE, CURRENT_ARTICLE_FILTER, MESSAGE_ID, NUMBER, OPEN_RANGE, RANGE |
Constructor Summary | |
---|---|
ArticleHeaderFilter(java.lang.String headerName,
java.lang.String range,
Wildmat matcher)
Create an article header filter with the given header name and wildmat pattern. |
Method Summary | |
---|---|
java.lang.String |
getHeader()
Obtains the name of the header that will have the wildmat pattern applied. |
Wildmat |
getWildmat()
Sets the wildmat pattern for this filter to use when restricting matching articles. |
void |
setHeader(java.lang.String headerName)
Sets the name of the header that will have the wildmat pattern applied. |
void |
setWildmat(Wildmat matcher)
Sets the wildmat pattern matcher for this filter to use when restricting matching articles by header. |
Methods inherited from class com.jivesoftware.forum.nntp.ArticleFilter |
---|
getArticleNumber, getEndIndex, getMessageID, getMode, getStartIndex, setRange |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ArticleHeaderFilter(java.lang.String headerName, java.lang.String range, Wildmat matcher)
Create an article header filter with the given header name and wildmat pattern.
headerName
- The header this filter will searchrange
- The range defining what articles to searchmatcher
- The pattern used to search the headerMethod Detail |
---|
public void setHeader(java.lang.String headerName)
Sets the name of the header that will have the wildmat pattern applied. Headers can only be one of the standard NNTP headers guaranteed to be on all articles (e.g. subject).
headerName
- The header this filter uses (e.g. subject)public java.lang.String getHeader()
Obtains the name of the header that will have the wildmat pattern applied. Headers can only be one of the standard NNTP headers guaranteed to be on all articles (e.g. subject).
public void setWildmat(Wildmat matcher)
Sets the wildmat pattern matcher for this filter to use when restricting matching articles by header.
matcher
- The wildmat patternpublic Wildmat getWildmat()
Sets the wildmat pattern for this filter to use when restricting matching articles.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |