NET-291 - document effect of calling connect
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/net/branches/NET_2_0@963363 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index 2b3513f..847a4ae 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -894,13 +894,16 @@
* Set the current data connection mode to
* <code> PASSIVE_LOCAL_DATA_CONNECTION_MODE </code>. Use this
* method only for data transfers between the client and server.
- * This method causes a PASV command to be issued to the server
+ * This method causes a PASV (or EPSV) command to be issued to the server
* before the opening of every data connection, telling the server to
* open a data port to which the client will connect to conduct
* data transfers. The FTPClient will stay in
* <code> PASSIVE_LOCAL_DATA_CONNECTION_MODE </code> until the
* mode is changed by calling some other method such as
* {@link #enterLocalActiveMode enterLocalActiveMode() }
+ * <p>
+ * <b>N.B.</b> currently calling any connect method will reset the mode to
+ * ACTIVE_LOCAL_DATA_CONNECTION_MODE.
***/
public void enterLocalPassiveMode()
{
@@ -1101,6 +1104,8 @@
* it again. The default file type is <code> FTP.ASCII_FILE_TYPE </code>
* if this method is never called.
* <p>
+ * <b>N.B.</b> currently calling any connect method will reset the mode to
+ * ACTIVE_LOCAL_DATA_CONNECTION_MODE.
* @param fileType The <code> _FILE_TYPE </code> constant indcating the
* type of file.
* @return True if successfully completed, false if not.
@@ -1137,6 +1142,9 @@
* is <code> FTP.NON_PRINT_TEXT_FORMAT </code> if this method is never
* called.
* <p>
+ * <b>N.B.</b> currently calling any connect method will reset the mode to
+ * ACTIVE_LOCAL_DATA_CONNECTION_MODE.
+ * <p>
* @param fileType The <code> _FILE_TYPE </code> constant indcating the
* type of file.
* @param formatOrByteSize The format of the file (one of the
