commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r748373 - in /commons/proper/net/trunk/src/java/org/apache/commons/net: SocketClient.java bsd/RCommandClient.java ftp/FTPClient.java nntp/Threader.java telnet/TelnetClient.java
Date Fri, 27 Feb 2009 01:44:30 GMT
Author: sebb
Date: Fri Feb 27 01:44:29 2009
New Revision: 748373

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

Modified:
    commons/proper/net/trunk/src/java/org/apache/commons/net/SocketClient.java
    commons/proper/net/trunk/src/java/org/apache/commons/net/bsd/RCommandClient.java
    commons/proper/net/trunk/src/java/org/apache/commons/net/ftp/FTPClient.java
    commons/proper/net/trunk/src/java/org/apache/commons/net/nntp/Threader.java
    commons/proper/net/trunk/src/java/org/apache/commons/net/telnet/TelnetClient.java

Modified: commons/proper/net/trunk/src/java/org/apache/commons/net/SocketClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/java/org/apache/commons/net/SocketClient.java?rev=748373&r1=748372&r2=748373&view=diff
==============================================================================
--- commons/proper/net/trunk/src/java/org/apache/commons/net/SocketClient.java (original)
+++ commons/proper/net/trunk/src/java/org/apache/commons/net/SocketClient.java Fri Feb 27
01:44:29 2009
@@ -22,6 +22,7 @@
 import java.net.InetAddress;
 import java.net.Socket;
 import java.net.SocketException;
+import java.net.UnknownHostException;
 
 /**
  * The SocketClient provides the basic operations that are required of
@@ -158,7 +159,7 @@
      * @exception UnknownHostException If the hostname cannot be resolved.
      */
     public void connect(String hostname, int port)
-    throws SocketException, IOException
+    throws SocketException, IOException, UnknownHostException
     {
         _socket_ = _socketFactory_.createSocket(hostname, port);
         _connectAction_();

Modified: commons/proper/net/trunk/src/java/org/apache/commons/net/bsd/RCommandClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/java/org/apache/commons/net/bsd/RCommandClient.java?rev=748373&r1=748372&r2=748373&view=diff
==============================================================================
--- commons/proper/net/trunk/src/java/org/apache/commons/net/bsd/RCommandClient.java (original)
+++ commons/proper/net/trunk/src/java/org/apache/commons/net/bsd/RCommandClient.java Fri Feb
27 01:44:29 2009
@@ -23,6 +23,7 @@
 import java.net.ServerSocket;
 import java.net.Socket;
 import java.net.SocketException;
+import java.net.UnknownHostException;
 
 import org.apache.commons.net.io.SocketInputStream;
 
@@ -244,7 +245,7 @@
      * @exception UnknownHostException If the hostname cannot be resolved.
      ***/
     public void connect(String hostname, int port)
-    throws SocketException, IOException
+    throws SocketException, IOException, UnknownHostException, BindException
     {
         connect(InetAddress.getByName(hostname), port, InetAddress.getLocalHost());
     }

Modified: commons/proper/net/trunk/src/java/org/apache/commons/net/ftp/FTPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/java/org/apache/commons/net/ftp/FTPClient.java?rev=748373&r1=748372&r2=748373&view=diff
==============================================================================
--- commons/proper/net/trunk/src/java/org/apache/commons/net/ftp/FTPClient.java (original)
+++ commons/proper/net/trunk/src/java/org/apache/commons/net/ftp/FTPClient.java Fri Feb 27
01:44:29 2009
@@ -2086,7 +2086,7 @@
      * @see org.apache.commons.net.ftp.FTPFileEntryParser
      * @deprecated use {@link  #listFiles()  listFiles()} or 
      * {@link  #listFiles(String)  listFiles(String)} instead and specify the
-     * parser Key in an {@link  #FTPClientConfig  FTPClientConfig} object instead.
+     * parser Key in an {@link  FTPClientConfig} object instead.
      */
     public FTPFile[] listFiles(String parserKey, String pathname)
     throws IOException
@@ -2475,13 +2475,6 @@
      * @exception IOException  If an I/O error occurs while either sending a
      *      command to the server or receiving a reply from the server.
      *
-     * @return The list of file information contained in the given path in
-     *         the format determined by<code> parserKey </code>parameter.
-     *         <p><b> 
-     *         NOTE:</b> This array may contain null members if any of the 
-     *         individual file listings failed to parse.  The caller should 
-     *         check each entry for null before referencing it.
-     *
      * @exception IOException
      * @since 5 Jan 2004
      * @deprecated use listFiles(String parserKey, String pathname) instead

Modified: commons/proper/net/trunk/src/java/org/apache/commons/net/nntp/Threader.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/java/org/apache/commons/net/nntp/Threader.java?rev=748373&r1=748372&r2=748373&view=diff
==============================================================================
--- commons/proper/net/trunk/src/java/org/apache/commons/net/nntp/Threader.java (original)
+++ commons/proper/net/trunk/src/java/org/apache/commons/net/nntp/Threader.java Fri Feb 27
01:44:29 2009
@@ -38,7 +38,7 @@
      * The main threader entry point - The client passes in an array of Threadable objects,
and 
      * the Threader constructs a connected 'graph' of messages
      * @param messages
-     * @return
+     * @return null if messages == null or root.child == null
      */
     public Threadable thread(Threadable[] messages) {
         if (messages == null)

Modified: commons/proper/net/trunk/src/java/org/apache/commons/net/telnet/TelnetClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/java/org/apache/commons/net/telnet/TelnetClient.java?rev=748373&r1=748372&r2=748373&view=diff
==============================================================================
--- commons/proper/net/trunk/src/java/org/apache/commons/net/telnet/TelnetClient.java (original)
+++ commons/proper/net/trunk/src/java/org/apache/commons/net/telnet/TelnetClient.java Fri
Feb 27 01:44:29 2009
@@ -186,13 +186,13 @@
     /***
      * Sends an Are You There sequence and waits for the result.
      * <p>
-     * @throws InterruptedException
-     * @throws IllegalArgumentException
-     * @throws IOException
-     * <p>
      * @param timeout - Time to wait for a response (millis.)
      * <p>
      * @return true if AYT received a response, false otherwise
+     * <p>
+     * @throws InterruptedException
+     * @throws IllegalArgumentException
+     * @throws IOException
      ***/
     public boolean sendAYT(long timeout)
     throws IOException, IllegalArgumentException, InterruptedException
@@ -206,9 +206,9 @@
     /***
      * Registers a new TelnetOptionHandler for this telnet client to use.
      * <p>
-     * @throws InvalidTelnetOptionException
-     * <p>
      * @param opthand - option handler to be registered.
+     * <p>
+     * @throws InvalidTelnetOptionException
      ***/
     public void addOptionHandler(TelnetOptionHandler opthand)
     throws InvalidTelnetOptionException
@@ -220,9 +220,9 @@
     /***
      * Unregisters a  TelnetOptionHandler.
      * <p>
-     * @throws InvalidTelnetOptionException
-     * <p>
      * @param optcode - Code of the option to be unregistered.
+     * <p>
+     * @throws InvalidTelnetOptionException
      ***/
     public void deleteOptionHandler(int optcode)
     throws InvalidTelnetOptionException



Mime
View raw message