Package org.apache.commons.net.nntp
Class NewsgroupInfo
- java.lang.Object
-
- org.apache.commons.net.nntp.NewsgroupInfo
-
public final class NewsgroupInfo extends java.lang.ObjectNewsgroupInfo stores information pertaining to a newsgroup returned by the NNTP GROUP, LIST, and NEWGROUPS commands, implemented byselectNewsgroup,listNewsgroups, andlistNewNewsgroupsrespectively.- See Also:
NNTPClient
-
-
Field Summary
Fields Modifier and Type Field Description (package private) static NewsgroupInfo[]EMPTY_ARRAYThe empty array of this type.private longestimatedArticleCountprivate longfirstArticleprivate longlastArticlestatic intMODERATED_POSTING_PERMISSIONA constant indicating that a newsgroup is moderated.private java.lang.Stringnewsgroupstatic intPERMITTED_POSTING_PERMISSIONA constant indicating that a newsgroup is public and unmoderated.private intpostingPermissionstatic intPROHIBITED_POSTING_PERMISSIONA constant indicating that a newsgroup is closed for general posting.static intUNKNOWN_POSTING_PERMISSIONA constant indicating that the posting permission of a newsgroup is unknown.
-
Constructor Summary
Constructors Constructor Description NewsgroupInfo()Constructs a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intgetArticleCount()Deprecated.longgetArticleCountLong()Gets the estimated number of articles in the newsgroup.intgetFirstArticle()Deprecated.longgetFirstArticleLong()Gets the number of the first article in the newsgroup.intgetLastArticle()Deprecated.longgetLastArticleLong()Gets the number of the last article in the newsgroup.java.lang.StringgetNewsgroup()Gets the newsgroup name.intgetPostingPermission()Gets the posting permission of the newsgroup.(package private) voidsetArticleCount(long count)(package private) voidsetFirstArticle(long first)(package private) voidsetLastArticle(long last)(package private) voidsetNewsgroup(java.lang.String newsgroup)(package private) voidsetPostingPermission(int permission)
-
-
-
Field Detail
-
UNKNOWN_POSTING_PERMISSION
public static final int UNKNOWN_POSTING_PERMISSION
A constant indicating that the posting permission of a newsgroup is unknown. For example, the NNTP GROUP command does not return posting information, so NewsgroupInfo instances obtained from that command will have an UNKNOWN_POSTING_PERMISSION.- See Also:
- Constant Field Values
-
MODERATED_POSTING_PERMISSION
public static final int MODERATED_POSTING_PERMISSION
A constant indicating that a newsgroup is moderated.- See Also:
- Constant Field Values
-
PERMITTED_POSTING_PERMISSION
public static final int PERMITTED_POSTING_PERMISSION
A constant indicating that a newsgroup is public and unmoderated.- See Also:
- Constant Field Values
-
PROHIBITED_POSTING_PERMISSION
public static final int PROHIBITED_POSTING_PERMISSION
A constant indicating that a newsgroup is closed for general posting.- See Also:
- Constant Field Values
-
EMPTY_ARRAY
static final NewsgroupInfo[] EMPTY_ARRAY
The empty array of this type.
-
newsgroup
private java.lang.String newsgroup
-
estimatedArticleCount
private long estimatedArticleCount
-
firstArticle
private long firstArticle
-
lastArticle
private long lastArticle
-
postingPermission
private int postingPermission
-
-
Method Detail
-
getArticleCount
@Deprecated public int getArticleCount()
Deprecated.Gets the estimated number of articles in the newsgroup. The accuracy of this value will depend on the server implementation.- Returns:
- The estimated number of articles in the newsgroup.
-
getArticleCountLong
public long getArticleCountLong()
Gets the estimated number of articles in the newsgroup. The accuracy of this value will depend on the server implementation.- Returns:
- The estimated number of articles in the newsgroup.
-
getFirstArticle
@Deprecated public int getFirstArticle()
Deprecated.Gets the number of the first article in the newsgroup.- Returns:
- The number of the first article in the newsgroup.
-
getFirstArticleLong
public long getFirstArticleLong()
Gets the number of the first article in the newsgroup.- Returns:
- The number of the first article in the newsgroup.
-
getLastArticle
@Deprecated public int getLastArticle()
Deprecated.Gets the number of the last article in the newsgroup.- Returns:
- The number of the last article in the newsgroup.
-
getLastArticleLong
public long getLastArticleLong()
Gets the number of the last article in the newsgroup.- Returns:
- The number of the last article in the newsgroup.
-
getNewsgroup
public java.lang.String getNewsgroup()
Gets the newsgroup name.- Returns:
- The name of the newsgroup.
-
getPostingPermission
public int getPostingPermission()
Gets the posting permission of the newsgroup. This will be one of thePOSTING_PERMISSIONconstants.- Returns:
- The posting permission status of the newsgroup.
-
setArticleCount
void setArticleCount(long count)
-
setFirstArticle
void setFirstArticle(long first)
-
setLastArticle
void setLastArticle(long last)
-
setNewsgroup
void setNewsgroup(java.lang.String newsgroup)
-
setPostingPermission
void setPostingPermission(int permission)
-
-