Source for gnu.inet.ftp.FTPResponse

   1: /*
   2:  * FTPResponse.java
   3:  * Copyright (C) 2003 The Free Software Foundation
   4:  * 
   5:  * This file is part of GNU inetlib, a library.
   6:  * 
   7:  * GNU inetlib is free software; you can redistribute it and/or modify
   8:  * it under the terms of the GNU General Public License as published by
   9:  * the Free Software Foundation; either version 2 of the License, or
  10:  * (at your option) any later version.
  11:  * 
  12:  * GNU inetlib is distributed in the hope that it will be useful,
  13:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15:  * GNU General Public License for more details.
  16:  * 
  17:  * You should have received a copy of the GNU General Public License
  18:  * along with this library; if not, write to the Free Software
  19:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20:  * 
  21:  * Linking this library statically or dynamically with other modules is
  22:  * making a combined work based on this library.  Thus, the terms and
  23:  * conditions of the GNU General Public License cover the whole
  24:  * combination.
  25:  *
  26:  * As a special exception, the copyright holders of this library give you
  27:  * permission to link this library with independent modules to produce an
  28:  * executable, regardless of the license terms of these independent
  29:  * modules, and to copy and distribute the resulting executable under
  30:  * terms of your choice, provided that you also meet, for each linked
  31:  * independent module, the terms and conditions of the license of that
  32:  * module.  An independent module is a module which is not derived from
  33:  * or based on this library.  If you modify this library, you may extend
  34:  * this exception to your version of the library, but you are not
  35:  * obliged to do so.  If you do not wish to do so, delete this
  36:  * exception statement from your version.
  37:  */
  38: 
  39: package gnu.inet.ftp;
  40: 
  41: /**
  42:  * An FTP control response.
  43:  *
  44:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  45:  */
  46: public final class FTPResponse
  47: {
  48: 
  49:   /**
  50:    * The 3-digit status code.
  51:    */
  52:   protected final int code;
  53: 
  54:   /**
  55:    * The human-readable message.
  56:    */
  57:   protected final String message;
  58: 
  59:   /**
  60:    * Multiline data, if present.
  61:    */
  62:   protected final String data;
  63: 
  64:   /**
  65:    * Constructs a new FTP response.
  66:    * @param code the status code
  67:    * @param message the message
  68:    */
  69:   public FTPResponse(int code, String message)
  70:   {
  71:     this(code, message, null);
  72:   }
  73: 
  74:   /**
  75:    * Constructs a new multiline FTP response.
  76:    * @param code the status code
  77:    * @param message the message
  78:    * @param data multiline data
  79:    */
  80:   public FTPResponse(int code, String message, String data)
  81:   {
  82:     this.code = code;
  83:     this.message = message;
  84:     this.data = data;
  85:   }
  86: 
  87:   /**
  88:    * Returns the 3-digit status code.
  89:    */
  90:   public int getCode()
  91:   {
  92:     return code;
  93:   }
  94: 
  95:   /**
  96:    * Returns the human-readable message.
  97:    */
  98:   public String getMessage()
  99:   {
 100:     return message;
 101:   }
 102: 
 103:   /**
 104:    * Returns the multiline data, or null if there was no such data.
 105:    */
 106:   public String getData()
 107:   {
 108:     return data;
 109:   }
 110: 
 111: }