View Javadoc

1   /*
2    * Copyright 2001-2005 The Apache Software Foundation
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.commons.net.nntp;
17  
18  /**
19   * This class is a structure used to return article number and unique
20   * id information extracted from an NNTP server reply.  You will normally
21   * want this information when issuing a STAT command, implemented by
22   * {@link NNTPClient#selectArticle selectArticle}.
23   * @author Daniel F. Savarese
24   * @see NNTPClient
25   */
26  public final class ArticlePointer
27  {
28      /** The number of the referenced article. */
29      public int articleNumber;
30      /**
31       * The unique id of the referenced article, including the enclosing
32       * &lt and &gt symbols which are technically not part of the
33       * identifier, but are required by all NNTP commands taking an
34       * article id as an argument.
35       */
36      public String articleId;
37  }