commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1230376 - in /commons/proper/net/trunk/src/main/java/org/apache/commons/net: ./ ftp/ imap/ nntp/ pop3/ smtp/ util/
Date Thu, 12 Jan 2012 02:30:51 GMT
Author: sebb
Date: Thu Jan 12 02:30:50 2012
New Revision: 1230376

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

Modified:
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSTrustManager.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ReplyIterator.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/ListenerList.java

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.java Thu Jan
12 02:30:50 2012
@@ -25,7 +25,6 @@ import java.net.InetAddress;
 import java.net.InetSocketAddress;
 import java.net.Socket;
 import java.net.SocketException;
-import java.net.UnknownHostException;
 
 import javax.net.ServerSocketFactory;
 import javax.net.SocketFactory;
@@ -185,7 +184,7 @@ public abstract class SocketClient
      * @exception IOException If the socket could not be opened.  In most
      *  cases you will only want to catch IOException since SocketException is
      *  derived from it.
-     * @exception UnknownHostException If the hostname cannot be resolved.
+     * @exception java.net.UnknownHostException If the hostname cannot be resolved.
      */
     public void connect(String hostname, int port)
     throws SocketException, IOException
@@ -240,7 +239,7 @@ public abstract class SocketClient
      * @exception IOException If the socket could not be opened.  In most
      *  cases you will only want to catch IOException since SocketException is
      *  derived from it.
-     * @exception UnknownHostException If the hostname cannot be resolved.
+     * @exception java.net.UnknownHostException If the hostname cannot be resolved.
      */
     public void connect(String hostname, int port,
                         InetAddress localAddr, int localPort)
@@ -279,7 +278,7 @@ public abstract class SocketClient
      * @exception IOException If the socket could not be opened.  In most
      *  cases you will only want to catch IOException since SocketException is
      *  derived from it.
-     * @exception UnknownHostException If the hostname cannot be resolved.
+     * @exception java.net.UnknownHostException If the hostname cannot be resolved.
      */
     public void connect(String hostname) throws SocketException, IOException
     {

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=1230376&r1=1230375&r2=1230376&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 Thu Jan
12 02:30:50 2012
@@ -44,11 +44,9 @@ import org.apache.commons.net.MalformedS
 import org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory;
 import org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory;
 import org.apache.commons.net.ftp.parser.MLSxEntryParser;
-import org.apache.commons.net.ftp.parser.ParserInitializationException;
 import org.apache.commons.net.io.CRLFLineReader;
 import org.apache.commons.net.io.CopyStreamAdapter;
 import org.apache.commons.net.io.CopyStreamEvent;
-import org.apache.commons.net.io.CopyStreamException;
 import org.apache.commons.net.io.CopyStreamListener;
 import org.apache.commons.net.io.FromNetASCIIInputStream;
 import org.apache.commons.net.io.ToNetASCIIOutputStream;
@@ -1294,7 +1292,7 @@ implements Configurable
      * Useful when there are multiple network cards.
      * <p>
      * @param ipAddress The external IP address of this machine.
-     * @throws UnknownHostException
+     * @throws UnknownHostException if the ipAddress cannot be resolved
      * @since 2.2
      ***/
     public void setActiveExternalIPAddress(String ipAddress) throws UnknownHostException
@@ -1307,7 +1305,7 @@ implements Configurable
      * Useful when there are multiple network cards.
      * <p>
      * @param ipAddress The external IP address of this machine.
-     * @throws UnknownHostException
+     * @throws UnknownHostException if the ipAddress cannot be resolved
      * @since 3.1
      * @see #getReportHostAddress()
      */
@@ -1647,7 +1645,8 @@ implements Configurable
      *      of the client being idle or some other reason causing the server
      *      to send FTP reply code 421.  This exception may be caught either
      *      as an IOException or independently as itself.
-     * @exception CopyStreamException  If an I/O error occurs while actually
+     * @exception org.apache.commons.net.io.CopyStreamException  
+     *      If an I/O error occurs while actually
      *      transferring the file.  The CopyStreamException allows you to
      *      determine the number of bytes transferred and the IOException
      *      causing the error.  This exception may be caught either
@@ -1772,7 +1771,8 @@ implements Configurable
      *      of the client being idle or some other reason causing the server
      *      to send FTP reply code 421.  This exception may be caught either
      *      as an IOException or independently as itself.
-     * @exception CopyStreamException  If an I/O error occurs while actually
+     * @exception org.apache.commons.net.io.CopyStreamException  
+     *      If an I/O error occurs while actually
      *      transferring the file.  The CopyStreamException allows you to
      *      determine the number of bytes transferred and the IOException
      *      causing the error.  This exception may be caught either
@@ -1833,7 +1833,8 @@ implements Configurable
      *      of the client being idle or some other reason causing the server
      *      to send FTP reply code 421.  This exception may be caught either
      *      as an IOException or independently as itself.
-     * @exception CopyStreamException  If an I/O error occurs while actually
+     * @exception org.apache.commons.net.io.CopyStreamException
+     *      If an I/O error occurs while actually
      *      transferring the file.  The CopyStreamException allows you to
      *      determine the number of bytes transferred and the IOException
      *      causing the error.  This exception may be caught either
@@ -1894,7 +1895,8 @@ implements Configurable
      *      of the client being idle or some other reason causing the server
      *      to send FTP reply code 421.  This exception may be caught either
      *      as an IOException or independently as itself.
-     * @exception CopyStreamException  If an I/O error occurs while actually
+     * @exception org.apache.commons.net.io.CopyStreamException
+     *      If an I/O error occurs while actually
      *      transferring the file.  The CopyStreamException allows you to
      *      determine the number of bytes transferred and the IOException
      *      causing the error.  This exception may be caught either
@@ -1956,7 +1958,8 @@ implements Configurable
      *      of the client being idle or some other reason causing the server
      *      to send FTP reply code 421.  This exception may be caught either
      *      as an IOException or independently as itself.
-     * @exception CopyStreamException  If an I/O error occurs while actually
+     * @exception org.apache.commons.net.io.CopyStreamException
+     *      If an I/O error occurs while actually
      *      transferring the file.  The CopyStreamException allows you to
      *      determine the number of bytes transferred and the IOException
      *      causing the error.  This exception may be caught either
@@ -2689,7 +2692,7 @@ implements Configurable
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply
      *                   from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the parserKey parameter cannot be
      *                   resolved by the selected parser factory.
      *                   In the DefaultFTPEntryParserFactory, this will
@@ -2736,7 +2739,7 @@ implements Configurable
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply
      *                   from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the parserKey parameter cannot be
      *                   resolved by the selected parser factory.
      *                   In the DefaultFTPEntryParserFactory, this will
@@ -2795,7 +2798,7 @@ implements Configurable
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply
      *                   from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the parserKey parameter cannot be
      *                   resolved by the selected parser factory.
      *                   In the DefaultFTPEntryParserFactory, this will
@@ -2836,7 +2839,7 @@ implements Configurable
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply
      *                   from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the parserKey parameter cannot be
      *                   resolved by the selected parser factory.
      *                   In the DefaultFTPEntryParserFactory, this will
@@ -2884,7 +2887,7 @@ implements Configurable
      * @exception IOException
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the autodetect mechanism cannot
      *                   resolve the type of system we are connected with.
      * @see FTPListParseEngine
@@ -2939,7 +2942,7 @@ implements Configurable
      * @exception IOException
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the autodetect mechanism cannot
      *                   resolve the type of system we are connected with.
      * @see FTPListParseEngine
@@ -2992,7 +2995,7 @@ implements Configurable
      * @exception IOException
      *                   If an I/O error occurs while either sending a
      *                   command to the server or receiving a reply from the server.
-     * @exception ParserInitializationException
+     * @exception org.apache.commons.net.ftp.parser.ParserInitializationException
      *                   Thrown if the parserKey parameter cannot be
      *                   resolved by the selected parser factory.
      *                   In the DefaultFTPEntryParserFactory, this will

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSTrustManager.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSTrustManager.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSTrustManager.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSTrustManager.java
Thu Jan 12 02:30:50 2012
@@ -22,12 +22,10 @@ import java.security.cert.X509Certificat
 
 import javax.net.ssl.X509TrustManager;
 
-import org.apache.commons.net.util.TrustManagerUtils;
-
 /**
  * Do not use.
  * @since 2.0
- * @deprecated 3.0 use {@link TrustManagerUtils#getValidateServerCertificateTrustManager()}
instead
+ * @deprecated 3.0 use {@link org.apache.commons.net.util.TrustManagerUtils#getValidateServerCertificateTrustManager()
TrustManagerUtils#getValidateServerCertificateTrustManager()} instead
  */
 @Deprecated
 public class FTPSTrustManager implements X509TrustManager

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPSClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPSClient.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPSClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPSClient.java Thu
Jan 12 02:30:50 2012
@@ -21,7 +21,6 @@ import java.io.BufferedWriter;
 import java.io.InputStreamReader;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
-import java.net.Socket;
 
 import javax.net.ssl.KeyManager;
 import javax.net.ssl.SSLContext;
@@ -244,7 +243,7 @@ public class IMAPSClient extends IMAPCli
     /**
      * Returns the names of the cipher suites which could be enabled
      * for use on this connection.
-     * When the underlying {@link Socket} is not an {@link SSLSocket} instance, returns null.
+     * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance,
returns null.
      * @return An array of cipher suite names, or <code>null</code>.
      */
     public String[] getEnabledCipherSuites()
@@ -270,7 +269,7 @@ public class IMAPSClient extends IMAPCli
     /**
      * Returns the names of the protocol versions which are currently
      * enabled for use on this connection.
-     * When the underlying {@link Socket} is not an {@link SSLSocket} instance, returns null.
+     * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance,
returns null.
      * @return An array of protocols, or <code>null</code>.
      */
     public String[] getEnabledProtocols()

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ReplyIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ReplyIterator.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ReplyIterator.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ReplyIterator.java
Thu Jan 12 02:30:50 2012
@@ -20,7 +20,6 @@ package org.apache.commons.net.nntp;
 
 import java.io.BufferedReader;
 import java.io.IOException;
-import java.io.Reader;
 import java.util.Iterator;
 import java.util.NoSuchElementException;
 
@@ -28,7 +27,7 @@ import org.apache.commons.net.io.DotTerm
 import org.apache.commons.net.io.Util;
 
 /**
- * Wraps a {@link Reader} and returns an {@code Iterable<String>}
+ * Wraps a {@link BufferedReader} and returns an {@code Iterable<String>}
  * which returns the individual lines from the reader.
  * @since 3.0
  */

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Client.java Thu
Jan 12 02:30:50 2012
@@ -17,7 +17,6 @@
 
 package org.apache.commons.net.pop3;
 
-import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.Reader;
 import java.security.MessageDigest;
@@ -501,8 +500,8 @@ public class POP3Client extends POP3
      * @param messageId  The number of the message to fetch.
      * @return A DotTerminatedMessageReader instance
      * from which the entire message can be read.
-     * This can safely be cast to a {@link BufferedReader} in order to
-     * use the {@link BufferedReader#readLine()} method.
+     * This can safely be cast to a {@link java.io.BufferedReader BufferedReader} in order
to
+     * use the {@link java.io.BufferedReader#readLine() BufferedReader#readLine()} method.
      * Returns null if the retrieval attempt fails  (e.g., if the specified
      * message number does not exist). 
      * @exception IOException If a network I/O error occurs in the process of
@@ -542,8 +541,8 @@ public class POP3Client extends POP3
      * @return  A DotTerminatedMessageReader instance
      * from which the specified top number of lines of the message can be
      * read.
-     * This can safely be cast to a {@link BufferedReader} in order to
-     * use the {@link BufferedReader#readLine()} method.
+     * This can safely be cast to a {@link java.io.BufferedReader BufferedReader} in order
to
+     * use the {@link java.io.BufferedReader#readLine() BufferedReader#readLine()} method.
      * Returns null if the retrieval attempt fails  (e.g., if the specified
      * message number does not exist).
      * @exception IOException If a network I/O error occurs in the process of

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3SClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3SClient.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3SClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3SClient.java Thu
Jan 12 02:30:50 2012
@@ -21,7 +21,6 @@ import java.io.BufferedWriter;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
-import java.net.Socket;
 
 import javax.net.ssl.KeyManager;
 import javax.net.ssl.SSLContext;
@@ -250,7 +249,7 @@ public class POP3SClient extends POP3Cli
     /**
      * Returns the names of the cipher suites which could be enabled
      * for use on this connection.
-     * When the underlying {@link Socket} is not an {@link SSLSocket} instance, returns null.
+     * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance,
returns null.
      * @return An array of cipher suite names, or <code>null</code>.
      */
     public String[] getEnabledCipherSuites()
@@ -276,7 +275,7 @@ public class POP3SClient extends POP3Cli
     /**
      * Returns the names of the protocol versions which are currently
      * enabled for use on this connection.
-     * When the underlying {@link Socket} is not an {@link SSLSocket} instance, returns null.
+     * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance,
returns null.
      * @return An array of protocols, or <code>null</code>.
      */
     public String[] getEnabledProtocols()

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/AuthenticatingSMTPClient.java
Thu Jan 12 02:30:50 2012
@@ -25,7 +25,6 @@ import java.security.spec.InvalidKeySpec
 import javax.crypto.Mac;
 import javax.crypto.spec.SecretKeySpec;
 
-import org.apache.commons.net.smtp.SMTPClient;
 import org.apache.commons.net.smtp.SMTPReply;
 import org.apache.commons.net.util.Base64;
 

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/SMTPSClient.java Thu
Jan 12 02:30:50 2012
@@ -21,7 +21,7 @@ import java.io.BufferedWriter;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
-import java.net.Socket;
+
 import javax.net.ssl.KeyManager;
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLException;
@@ -228,7 +228,7 @@ public class SMTPSClient extends SMTPCli
     /**
      * Returns the names of the cipher suites which could be enabled
      * for use on this connection.
-     * When the underlying {@link Socket} is not an {@link SSLSocket} instance, returns null.
+     * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance,
returns null.
      * @return An array of cipher suite names, or <code>null</code>.
      */
     public String[] getEnabledCipherSuites()
@@ -254,7 +254,7 @@ public class SMTPSClient extends SMTPCli
     /**
      * Returns the names of the protocol versions which are currently
      * enabled for use on this connection.
-     * When the underlying {@link Socket} is not an {@link SSLSocket} instance, returns null.
+     * When the underlying {@link java.net.Socket Socket} is not an {@link SSLSocket} instance,
returns null.
      * @return An array of protocols, or <code>null</code>.
      */
     public String[] getEnabledProtocols()

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/ListenerList.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/ListenerList.java?rev=1230376&r1=1230375&r2=1230376&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/ListenerList.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/ListenerList.java Thu
Jan 12 02:30:50 2012
@@ -52,8 +52,9 @@ public class ListenerList implements Ser
     }
 
     /**
-     * Return an {@link Iterator} for the {@link EventListener} instances
+     * Return an {@link Iterator} for the {@link EventListener} instances.
      *
+     * @return an {@link Iterator} for the {@link EventListener} instances
      * @since 2.0
      * TODO Check that this is a good defensive strategy
      */



Mime
View raw message