Package org.apache.commons.net.nntp

Class NewsgroupInfo

java.lang.Object

org.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.

See Also:

NNTPClient

Field Summary

Fields

Modifier and Type	Field	Description
private long	estimatedArticleCount
private long	firstArticle
private long	lastArticle
static int	MODERATED_POSTING_PERMISSION	A constant indicating that a newsgroup is moderated.
private java.lang.String	newsgroup
static int	PERMITTED_POSTING_PERMISSION	A constant indicating that a newsgroup is public and unmoderated.
private int	postingPermission
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

Constructors

Constructor	Description
NewsgroupInfo()

Method Summary

Modifier and Type	Method	Description
int	getArticleCount()	Deprecated.
long	getArticleCountLong()	Get the estimated number of articles in the newsgroup.
int	getFirstArticle()	Deprecated.
long	getFirstArticleLong()	Get the number of the first article in the newsgroup.
int	getLastArticle()	Deprecated.
long	getLastArticleLong()	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.
(package private) void	setArticleCount(long count)
(package private) void	setFirstArticle(long first)
(package private) void	setLastArticle(long last)
(package private) void	setNewsgroup(java.lang.String newsgroup)
(package private) void	setPostingPermission(int permission)

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 long estimatedArticleCount

firstArticle

private long firstArticle

lastArticle

private long lastArticle

postingPermission

private int postingPermission

Constructor Detail

NewsgroupInfo

public NewsgroupInfo()

Method Detail

setNewsgroup

void setNewsgroup(java.lang.String newsgroup)

setArticleCount

void setArticleCount(long count)

setFirstArticle

void setFirstArticle(long first)

setLastArticle

void setLastArticle(long last)

setPostingPermission

void setPostingPermission(int permission)

getNewsgroup

public java.lang.String 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 the POSTING_PERMISSION constants.

Returns:

The posting permission status of the newsgroup.

getArticleCount

@Deprecated
public int getArticleCount()

Deprecated.

getFirstArticle

@Deprecated
public int getFirstArticle()

Deprecated.

getLastArticle

@Deprecated
public int getLastArticle()

Deprecated.