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

Constructors

Constructor	Description
NewsgroupInfo()

Method Summary

Modifier and Type	Method	Description
(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)
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.

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.