[Cherbot-commit] SF.net SVN: cherbot: [85] trunk/src/net/sf/cherbot/AbstractConnection.java

[<chr...@us...>]

Revision: 85
          http://svn.sourceforge.net/cherbot/?rev=85&view=rev
Author:   christianhujer
Date:     2007-06-20 13:14:11 -0700 (Wed, 20 Jun 2007)

Log Message:
-----------
Improved documentation.

Modified Paths:
--------------
    trunk/src/net/sf/cherbot/AbstractConnection.java

Modified: trunk/src/net/sf/cherbot/AbstractConnection.java
===================================================================
--- trunk/src/net/sf/cherbot/AbstractConnection.java	2007-06-20 20:10:27 UTC (rev 84)
+++ trunk/src/net/sf/cherbot/AbstractConnection.java	2007-06-20 20:14:11 UTC (rev 85)
@@ -17,6 +17,18 @@
 import java.io.Serializable;
 
 /** An AbstractConnection represents the connection to a server and has one or more channels.
+ * Connections are implemented as command bean.
+ * That means:
+ * <ul>
+ *  <li>
+ *      An object does not reflect an established connection but has a state.
+ *      The connection state can be established or not established.
+ *  </li>
+ *  <li>
+ *      For testing, trying or standalone usage it is possible to "run" a connection as a standalone java program from the command line.
+ *  </li>
+ * </ul>
+ * To query whether the connection is open, get the Socket of the connection and check the socket.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public abstract class AbstractConnection extends BasicCommand implements Closeable, Serializable {
@@ -64,7 +76,7 @@
         return port;
     }
 
-    /** Establishes the connection.
+    /** Establishes this connection.
      * @return The socket created for this connection.
      * @throws IOException in case of connection problems.
      */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.