org.apache.commons.net.nntp
Class NewsgroupInfo

java.lang.Object
  extended byorg.apache.commons.net.nntp.NewsgroupInfo

public final class NewsgroupInfo
extends java.lang.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:
NNTPClient

Field Summary
private  int __estimatedArticleCount
           
private  int __firstArticle
           
private  int __lastArticle
           
private  java.lang.String __newsgroup
           
private  int __postingPermission
           
static int MODERATED_POSTING_PERMISSION
          A constant indicating that a newsgroup is moderated.
static int PERMITTED_POSTING_PERMISSION
          A constant indicating that a newsgroup is public and unmoderated.
static int PROHIBITED_POSTING_PERMISSION
          A constant indicating that a newsgroup is closed for general posting.
static int UNKNOWN_POSTING_PERMISSION
          A constant indicating that the posting permission of a newsgroup is unknown.
 
Constructor Summary
NewsgroupInfo()
           
 
Method Summary
(package private)  void _setArticleCount(int count)
           
(package private)  void _setFirstArticle(int first)
           
(package private)  void _setLastArticle(int last)
           
(package private)  void _setNewsgroup(java.lang.String newsgroup)
           
(package private)  void _setPostingPermission(int permission)
           
 int getArticleCount()
          Get the estimated number of articles in the newsgroup.
 int getFirstArticle()
          Get the number of the first article in the newsgroup.
 int getLastArticle()
          Get the number of the last article in the newsgroup.
 java.lang.String getNewsgroup()
          Get the newsgroup name.
 int getPostingPermission()
          Get the posting permission of the newsgroup.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 willhave 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

__newsgroup

private java.lang.String __newsgroup

__estimatedArticleCount

private int __estimatedArticleCount

__firstArticle

private int __firstArticle

__lastArticle

private int __lastArticle

__postingPermission

private int __postingPermission
Constructor Detail

NewsgroupInfo

public NewsgroupInfo()
Method Detail

_setNewsgroup

void _setNewsgroup(java.lang.String newsgroup)

_setArticleCount

void _setArticleCount(int count)

_setFirstArticle

void _setFirstArticle(int first)

_setLastArticle

void _setLastArticle(int last)

_setPostingPermission

void _setPostingPermission(int permission)

getNewsgroup

public java.lang.String getNewsgroup()
Get the newsgroup name.

Returns:
The name of the newsgroup.

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.

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.