org.apache.commons.net.nntp

Class NewsgroupInfo

public final class NewsgroupInfo extends Object

NewsgroupInfo stores information pertaining to a newsgroup returned by the NNTP GROUP, LIST, and NEWGROUPS commands, implemented by selectNewsgroup , listNewsgroups , and listNewNewsgroups respectively.

Author: Daniel F. Savarese

See Also:

Field Summary
static intMODERATED_POSTING_PERMISSION
A constant indicating that a newsgroup is moderated.
static intPERMITTED_POSTING_PERMISSION
A constant indicating that a newsgroup is public and unmoderated.
static intPROHIBITED_POSTING_PERMISSION
A constant indicating that a newsgroup is closed for general posting.
static intUNKNOWN_POSTING_PERMISSION
A constant indicating that the posting permission of a newsgroup is unknown.
Method Summary
intgetArticleCount()
Get the estimated number of articles in the newsgroup.
intgetFirstArticle()
Get the number of the first article in the newsgroup.
intgetLastArticle()
Get the number of the last article in the newsgroup.
StringgetNewsgroup()
Get the newsgroup name.
intgetPostingPermission()
Get the posting permission of the newsgroup.

Field Detail

MODERATED_POSTING_PERMISSION

public static final int MODERATED_POSTING_PERMISSION
A constant indicating that a newsgroup is moderated. **

PERMITTED_POSTING_PERMISSION

public static final int PERMITTED_POSTING_PERMISSION
A constant indicating that a newsgroup is public and unmoderated. **

PROHIBITED_POSTING_PERMISSION

public static final int PROHIBITED_POSTING_PERMISSION
A constant indicating that a newsgroup is closed for general posting.

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 willhave an UNKNOWN_POSTING_PERMISSION.

Method Detail

getArticleCount

public int getArticleCount()
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.

getFirstArticle

public int getFirstArticle()
Get the number of the first article in the newsgroup.

Returns: The number of the first article in the newsgroup.

getLastArticle

public int getLastArticle()
Get the number of the last article in the newsgroup.

Returns: The number of the last article in the newsgroup.

getNewsgroup

public String getNewsgroup()
Get the newsgroup name.

Returns: The name of the newsgroup.

getPostingPermission

public int getPostingPermission()
Get the posting permission of the newsgroup. This will be one of the POSTING_PERMISSION constants.

Returns: The posting permission status of the newsgroup.