You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/09/18 13:56:46 UTC

[commons-net] 02/04: Javadoc

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git

commit 1717554a6df4f85f51a0a5f68350fff71b495634
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Sep 18 09:53:01 2023 -0400

    Javadoc
---
 .../org/apache/commons/net/ftp/FTPCommand.java     | 189 +++++++++++++++++++--
 1 file changed, 178 insertions(+), 11 deletions(-)

diff --git a/src/main/java/org/apache/commons/net/ftp/FTPCommand.java b/src/main/java/org/apache/commons/net/ftp/FTPCommand.java
index 6d55cbab..6f272135 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPCommand.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPCommand.java
@@ -27,64 +27,156 @@ package org.apache.commons.net.ftp;
 @Deprecated
 public final class FTPCommand {
 
+    /** Command code {@value}. */
     public static final int USER = 0;
+
+    /** Command code {@value}. */
     public static final int PASS = 1;
+
+    /** Command code {@value}. */
     public static final int ACCT = 2;
+
+    /** Command code {@value}. */
     public static final int CWD = 3;
+
+    /** Command code {@value}. */
     public static final int CDUP = 4;
+
+    /** Command code {@value}. */
     public static final int SMNT = 5;
+
+    /** Command code {@value}. */
     public static final int REIN = 6;
+
+    /** Command code {@value}. */
     public static final int QUIT = 7;
+
+    /** Command code {@value}. */
     public static final int PORT = 8;
+
+    /** Command code {@value}. */
     public static final int PASV = 9;
+
+    /** Command code {@value}. */
     public static final int TYPE = 10;
+
+    /** Command code {@value}. */
     public static final int STRU = 11;
+
+    /** Command code {@value}. */
     public static final int MODE = 12;
+
+    /** Command code {@value}. */
     public static final int RETR = 13;
+
+    /** Command code {@value}. */
     public static final int STOR = 14;
+
+    /** Command code {@value}. */
+
+    /** Command code {@value}. */
     public static final int STOU = 15;
+
+    /** Command code {@value}. */
     public static final int APPE = 16;
+
+    /** Command code {@value}. */
+
+    /** Command code {@value}. */
     public static final int ALLO = 17;
+
+    /** Command code {@value}. */
     public static final int REST = 18;
+
+    /** Command code {@value}. */
     public static final int RNFR = 19;
+
+    /** Command code {@value}. */
     public static final int RNTO = 20;
+
+    /** Command code {@value}. */
     public static final int ABOR = 21;
+
+    /** Command code {@value}. */
     public static final int DELE = 22;
+
+    /** Command code {@value}. */
     public static final int RMD = 23;
+
+    /** Command code {@value}. */
     public static final int MKD = 24;
+
+    /** Command code {@value}. */
     public static final int PWD = 25;
+
+    /** Command code {@value}. */
     public static final int LIST = 26;
+
+    /** Command code {@value}. */
     public static final int NLST = 27;
+
+    /** Command code {@value}. */
     public static final int SITE = 28;
+
+    /** Command code {@value}. */
     public static final int SYST = 29;
+
+    /** Command code {@value}. */
     public static final int STAT = 30;
+
+    /** Command code {@value}. */
+
+    /** Command code {@value}. */
     public static final int HELP = 31;
+
+    /** Command code {@value}. */
     public static final int NOOP = 32;
 
-    /** @since 2.0 */
+
+    /**
+     * Command code {@value}.
+     *
+     * @since 2.0
+     */
     public static final int MDTM = 33;
 
-    /** @since 2.2 */
+    /**
+     * Command code {@value}.
+     *
+     * @since 2.2
+     */
     public static final int FEAT = 34;
 
-    /** @since 2.2 */
+    /**
+     * Command code {@value}.
+     *
+     * @since 2.0
+     */
     public static final int MFMT = 35;
 
-    /** @since 2.2 */
+    /**
+     * Command code {@value}.
+     *
+     * @since 2.0
+     */
     public static final int EPSV = 36;
 
-    /** @since 2.2 */
+    /**
+     * Command code {@value}.
+     *
+     * @since 2.0
+     */
     public static final int EPRT = 37;
 
     /**
-     * Machine parseable list for a directory
+     * Machine parseable list for a directory.
      *
      * @since 3.0
      */
     public static final int MLSD = 38;
 
     /**
-     * Machine parseable list for a single file
+     * Machine parseable list for a single file.
      *
      * @since 3.0
      */
@@ -93,48 +185,123 @@ public final class FTPCommand {
     // Must agree with final entry above; used to check array size
     private static final int LAST = MLST;
 
+    /** Alias for {@value}. */
     public static final int USERNAME = USER;
+
+    /** Alias for {@value}. */
     public static final int PASSWORD = PASS;
+
+    /** Alias for {@value}. */
     public static final int ACCOUNT = ACCT;
+
+    /** Alias for {@value}. */
     public static final int CHANGE_WORKING_DIRECTORY = CWD;
+
+    /** Alias for {@value}. */
     public static final int CHANGE_TO_PARENT_DIRECTORY = CDUP;
+
+    /** Alias for {@value}. */
     public static final int STRUCTURE_MOUNT = SMNT;
+
+    /** Alias for {@value}. */
     public static final int REINITIALIZE = REIN;
+
+    /** Alias for {@value}. */
     public static final int LOGOUT = QUIT;
+
+    /** Alias for {@value}. */
     public static final int DATA_PORT = PORT;
+
+    /** Alias for {@value}. */
     public static final int PASSIVE = PASV;
+
+    /** Alias for {@value}. */
     public static final int REPRESENTATION_TYPE = TYPE;
+
+    /** Alias for {@value}. */
     public static final int FILE_STRUCTURE = STRU;
+
+    /** Alias for {@value}. */
     public static final int TRANSFER_MODE = MODE;
+
+    /** Alias for {@value}. */
     public static final int RETRIEVE = RETR;
+
+    /** Alias for {@value}. */
     public static final int STORE = STOR;
+
+    /** Alias for {@value}. */
     public static final int STORE_UNIQUE = STOU;
+
+    /** Alias for {@value}. */
     public static final int APPEND = APPE;
+
+    /** Alias for {@value}. */
     public static final int ALLOCATE = ALLO;
+
+    /** Alias for {@value}. */
     public static final int RESTART = REST;
+
+    /** Alias for {@value}. */
     public static final int RENAME_FROM = RNFR;
+
+    /** Alias for {@value}. */
     public static final int RENAME_TO = RNTO;
+
+    /** Alias for {@value}. */
     public static final int ABORT = ABOR;
+
+    /** Alias for {@value}. */
     public static final int DELETE = DELE;
+
+    /** Alias for {@value}. */
     public static final int REMOVE_DIRECTORY = RMD;
+
+    /** Alias for {@value}. */
     public static final int MAKE_DIRECTORY = MKD;
+
+    /** Alias for {@value}. */
     public static final int PRINT_WORKING_DIRECTORY = PWD;
+
     // public static final int LIST = LIST;
+
+    /** Alias for {@value}. */
     public static final int NAME_LIST = NLST;
+
+    /** Alias for {@value}. */
     public static final int SITE_PARAMETERS = SITE;
+
+    /** Alias for {@value}. */
     public static final int SYSTEM = SYST;
+
+    /** Alias for {@value}. */
     public static final int STATUS = STAT;
+
     // public static final int HELP = HELP;
     // public static final int NOOP = NOOP;
 
-    /** @since 2.0 */
+    /**
+     * Alias for {@value}.
+     * @since 2.0
+     */
     public static final int MOD_TIME = MDTM;
 
-    /** @since 2.2 */
+    /**
+     * Alias for {@value}.
+     * @since 2.2
+     */
     public static final int FEATURES = FEAT;
-    /** @since 2.2 */
+
+    /**
+     * Alias for {@value}.
+     * @since 2.2
+     */
     public static final int GET_MOD_TIME = MDTM;
-    /** @since 2.2 */
+
+    /**
+     * Alias for {@value}.
+     * @since 2.2
+     */
     public static final int SET_MOD_TIME = MFMT;
 
     private static final String[] COMMANDS = { "USER", "PASS", "ACCT", "CWD", "CDUP", "SMNT", "REIN", "QUIT", "PORT", "PASV", "TYPE", "STRU", "MODE", "RETR",