ArticlePointer.java

  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. package org.apache.commons.net.nntp;

  18. /**
  19.  * This class is a structure used to return article number and unique id information extracted from an NNTP server reply. You will normally want this
  20.  * information when issuing a STAT command, implemented by {@link NNTPClient#selectArticle selectArticle}.
  21.  *
  22.  * @see NNTPClient
  23.  *
  24.  * @deprecated 3.0 use {@link ArticleInfo} instead
  25.  */
  26. @Deprecated
  27. public final class ArticlePointer {
  28.     /** The number of the referenced article. */
  29.     public int articleNumber;
  30.     /**
  31.      * The unique id of the referenced article, including the enclosing < and > symbols which are technically not part of the identifier, but are required
  32.      * by all NNTP commands taking an article id as an argument.
  33.      */
  34.     public String articleId;
  35. }