Package org.apache.commons.net.nntp
Class NewsgroupInfo
java.lang.Object
org.apache.commons.net.nntp.NewsgroupInfo
NewsgroupInfo stores information pertaining to a newsgroup returned by
the NNTP GROUP, LIST, and NEWGROUPS commands, implemented by
selectNewsgroup
,
listNewsgroups
, and
listNewNewsgroups
respectively.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate long
private long
private long
static final int
A constant indicating that a newsgroup is moderated.private String
static final int
A constant indicating that a newsgroup is public and unmoderated.private int
static final int
A constant indicating that a newsgroup is closed for general posting.static final int
A constant indicating that the posting permission of a newsgroup is unknown. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated.long
Get the estimated number of articles in the newsgroup.int
Deprecated.long
Get the number of the first article in the newsgroup.int
Deprecated.long
Get the number of the last article in the newsgroup.Get the newsgroup name.int
Get the posting permission of the newsgroup.(package private) void
setArticleCount
(long count) (package private) void
setFirstArticle
(long first) (package private) void
setLastArticle
(long last) (package private) void
setNewsgroup
(String newsgroup) (package private) void
setPostingPermission
(int permission)
-
Field Details
-
UNKNOWN_POSTING_PERMISSION
public static final int UNKNOWN_POSTING_PERMISSIONA 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 willhave an UNKNOWN_POSTING_PERMISSION.- See Also:
-
MODERATED_POSTING_PERMISSION
public static final int MODERATED_POSTING_PERMISSIONA constant indicating that a newsgroup is moderated.- See Also:
-
PERMITTED_POSTING_PERMISSION
public static final int PERMITTED_POSTING_PERMISSIONA constant indicating that a newsgroup is public and unmoderated.- See Also:
-
PROHIBITED_POSTING_PERMISSION
public static final int PROHIBITED_POSTING_PERMISSIONA constant indicating that a newsgroup is closed for general posting.- See Also:
-
newsgroup
-
estimatedArticleCount
private long estimatedArticleCount -
firstArticle
private long firstArticle -
lastArticle
private long lastArticle -
postingPermission
private int postingPermission
-
-
Constructor Details
-
NewsgroupInfo
public NewsgroupInfo()
-
-
Method Details
-
setNewsgroup
-
setArticleCount
void setArticleCount(long count) -
setFirstArticle
void setFirstArticle(long first) -
setLastArticle
void setLastArticle(long last) -
setPostingPermission
void setPostingPermission(int permission) -
getNewsgroup
Get the newsgroup name.- Returns:
- The name of the newsgroup.
-
getArticleCountLong
public long getArticleCountLong()Get 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.
-
getFirstArticleLong
public long getFirstArticleLong()Get the number of the first article in the newsgroup.- Returns:
- The number of the first article in the newsgroup.
-
getLastArticleLong
public long getLastArticleLong()Get the number of the last article in the newsgroup.- Returns:
- The number of the last article in the newsgroup.
-
getPostingPermission
public int getPostingPermission()Get the posting permission of the newsgroup. This will be one of thePOSTING_PERMISSION
constants.- Returns:
- The posting permission status of the newsgroup.
-
getArticleCount
Deprecated. -
getFirstArticle
Deprecated. -
getLastArticle
Deprecated.
-