svn commit: r1050328 - /servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/SocketClientPoolSupport.java

[ge...@apache.org]

Author: gertv
Date: Fri Dec 17 09:52:24 2010
New Revision: 1050328

URL: http://svn.apache.org/viewvc?rev=1050328&view=rev
Log:
SMXCOMP-833: Improve servicemix-ftp javadoc for wiki/xsd documentation (ftp:pool)

Modified:
    servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/SocketClientPoolSupport.java

Modified: servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/SocketClientPoolSupport.java
URL: http://svn.apache.org/viewvc/servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/SocketClientPoolSupport.java?rev=1050328&r1=1050327&r2=1050328&view=diff
==============================================================================
--- servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/SocketClientPoolSupport.java (original)
+++ servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/SocketClientPoolSupport.java Fri Dec 17 09:52:24 2010
@@ -96,6 +96,11 @@ public abstract class SocketClientPoolSu
         return address;
     }
 
+    /**
+     * Set the remote internet address to connect to.
+     *
+     * @param address
+     */
     public void setAddress(InetAddress address) {
         this.address = address;
     }
@@ -104,6 +109,11 @@ public abstract class SocketClientPoolSu
         return host;
     }
 
+    /**
+     * Set the remote host name to connect to.
+     *
+     * @param host
+     */
     public void setHost(String host) {
         this.host = host;
     }
@@ -112,6 +122,11 @@ public abstract class SocketClientPoolSu
         return localAddress;
     }
 
+    /**
+     * Set the local IP address to be used when establishing the connection.
+     *
+     * @param localAddress
+     */
     public void setLocalAddress(InetAddress localAddress) {
         this.localAddress = localAddress;
     }
@@ -120,6 +135,11 @@ public abstract class SocketClientPoolSu
         return localPort;
     }
 
+    /**
+     * Set the local TCP/IP port to be used when establishing the connection.
+     *
+     * @param localPort
+     */
     public void setLocalPort(int localPort) {
         this.localPort = localPort;
     }
@@ -128,6 +148,11 @@ public abstract class SocketClientPoolSu
         return port;
     }
 
+    /**
+     * Set the remote port number to connect to.
+     *
+     * @param port
+     */
     public void setPort(int port) {
         this.port = port;
     }
@@ -136,6 +161,11 @@ public abstract class SocketClientPoolSu
         return pool;
     }
 
+    /**
+     * Set a custom ObjectPool instance to use for the connection pooling.
+     *
+     * @param pool
+     */
     public void setPool(ObjectPool pool) {
         if (pool != null) {
             pool.setFactory(this);