commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1085720 - /commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java
Date Sat, 26 Mar 2011 13:47:04 GMT
Author: sebb
Date: Sat Mar 26 13:47:03 2011
New Revision: 1085720

URL: http://svn.apache.org/viewvc?rev=1085720&view=rev
Log:
Javadoc

Modified:
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java?rev=1085720&r1=1085719&r2=1085720&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java Sat Mar
26 13:47:03 2011
@@ -273,15 +273,28 @@ public class FTPClient extends FTP
 implements Configurable
 {
     /**
-     * The system property ({@value}) which can be used to override the system type.
+     * The system property ({@value}) which can be used to override the system type.<br/>
+     * If defined, the value will be used to create any automatically created parsers.
+     *
      * @since 3.0
      */
     public static final String FTP_SYSTEM_TYPE = "org.apache.commons.net.ftp.systemType";
 
     /**
-     * The name of the systemType properties file ({@value}).
+     * The name of an optional systemType properties file ({@value}), which is loaded
+     * using {@link Class#getResourceAsStream(String)}.<br/>
+     * The entries are the systemType (as determined by {@link FTPClient#getSystemType})
+     * and the values are the replacement type or parserClass, which is passed to
+     * {@link FTPFileEntryParserFactory#createFileEntryParser(String)}.<br/>
+     * For example:
+     * <pre>
+     * Plan 9=Unix
+     * OS410=org.apache.commons.net.ftp.parser.OS400FTPEntryParser
+     * </pre>
+     *
+     * @since 3.0
      */
-    private static final String SYSTEM_TYPE_PROPERTIES = "/systemType.properties";
+    public static final String SYSTEM_TYPE_PROPERTIES = "/systemType.properties";
 
     /***
      * A constant indicating the FTP session is expecting all transfers



Mime
View raw message