/*
 * ArticleResponse.java
 * Copyright (C) 2002 The Free Software Foundation
 * 
 * This file is part of GNU inetlib, a library.
 * 
 * GNU inetlib is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * GNU inetlib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Linking this library statically or dynamically with other modules is
 * making a combined work based on this library.  Thus, the terms and
 * conditions of the GNU General Public License cover the whole
 * combination.
 *
 * As a special exception, the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent
 * modules, and to copy and distribute the resulting executable under
 * terms of your choice, provided that you also meet, for each linked
 * independent module, the terms and conditions of the license of that
 * module.  An independent module is a module which is not derived from
 * or based on this library.  If you modify this library, you may extend
 * this exception to your version of the library, but you are not
 * obliged to do so.  If you do not wish to do so, delete this
 * exception statement from your version.
 */

package gnu.inet.nntp;

import java.io.InputStream;

/**
 * An NNTP article status response.
 * This represents the status response associated with NNTP status codes
 * 220-223, including an article number and a message-id.
 *
 * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
 */
public class ArticleResponse
  extends StatusResponse
{

  /*
   * The article number.
   */
  public int articleNumber;

  /*
   * The message-id.
   */
  public String messageId;

  /**
   * If the status code for this response is one of:
   * <ul>
   * <li>ARTICLE_FOLLOWS
   * <li>HEAD_FOLLOWS
   * <li>BODY_FOLLOWS
   * </ul>
   * then this stream can be used to retrieve the byte content of the article
   * retrieved. Otherwise, it will be null. If it is non-null, the stream
   * must be read in its entirety before further methods can be invoked on
   * the NNTPConnection.
   */
  public InputStream in;

  protected ArticleResponse(short status, String message)
  {
    super(status, message);
  }

}

