View Javadoc

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