What this is
This file is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn
Java by Example" TM.
Other links
The source code
/*
* Copyright 2001-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.net.nntp;
/***
* 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 NNTPClient
***/
public final class NewsgroupInfo
{
/***
* 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.
***/
public static final int UNKNOWN_POSTING_PERMISSION = 0;
/*** A constant indicating that a newsgroup is moderated. ***/
public static final int MODERATED_POSTING_PERMISSION = 1;
/*** A constant indicating that a newsgroup is public and unmoderated. ***/
public static final int PERMITTED_POSTING_PERMISSION = 2;
/***
* A constant indicating that a newsgroup is closed for general posting.
***/
public static final int PROHIBITED_POSTING_PERMISSION = 3;
private String __newsgroup;
private int __estimatedArticleCount;
private int __firstArticle, __lastArticle;
private int __postingPermission;
void _setNewsgroup(String newsgroup)
{
__newsgroup = newsgroup;
}
void _setArticleCount(int count)
{
__estimatedArticleCount = count;
}
void _setFirstArticle(int first)
{
__firstArticle = first;
}
void _setLastArticle(int last)
{
__lastArticle = last;
}
void _setPostingPermission(int permission)
{
__postingPermission = permission;
}
/***
* Get the newsgroup name.
*
* @return The name of the newsgroup.
***/
public String getNewsgroup()
{
return __newsgroup;
}
/***
* Get the estimated number of articles in the newsgroup. The
* accuracy of this value will depend on the server implementation.
*
* @return The estimated number of articles in the newsgroup.
***/
public int getArticleCount()
{
return __estimatedArticleCount;
}
/***
* Get the number of the first article in the newsgroup.
*
* @return The number of the first article in the newsgroup.
***/
public int getFirstArticle()
{
return __firstArticle;
}
/***
* Get the number of the last article in the newsgroup.
*
* @return The number of the last article in the newsgroup.
***/
public int getLastArticle()
{
return __lastArticle;
}
/***
* Get the posting permission of the newsgroup. This will be one of
* the POSTING_PERMISSION constants.
*
* @return The posting permission status of the newsgroup.
***/
public int getPostingPermission()
{
return __postingPermission;
}
/*
public String toString() {
StringBuffer buffer = new StringBuffer();
buffer.append(__newsgroup);
buffer.append(' ');
buffer.append(__lastArticle);
buffer.append(' ');
buffer.append(__firstArticle);
buffer.append(' ');
switch(__postingPermission) {
case 1: buffer.append('m'); break;
case 2: buffer.append('y'); break;
case 3: buffer.append('n'); break;
}
return buffer.toString();
}
*/
}
|