commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1587002 - in /commons/proper/net/trunk/src/main/java/org/apache/commons/net: bsd/ ftp/parser/ imap/ io/ tftp/
Date Sun, 13 Apr 2014 14:18:03 GMT
Author: sebb
Date: Sun Apr 13 14:18:02 2014
New Revision: 1587002

URL: http://svn.apache.org/r1587002
Log:
Java 8 Javadoc fixes

Modified:
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RLoginClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacketException.java

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RCommandClient.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RCommandClient.java
Sun Apr 13 14:18:02 2014
@@ -394,6 +394,10 @@ public class RCommandClient extends RExe
     /***
      * Same as
      * <code> rcommand(localUsername, remoteUsername, command, false); </code>
+     * @param localUsername the local user
+     * @param remoteUsername the remote user
+     * @param command the command
+     * @throws IOException on error
      ***/
     public void rcommand(String localUsername, String remoteUsername,
                          String command)

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RLoginClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RLoginClient.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RLoginClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/bsd/RLoginClient.java Sun
Apr 13 14:18:02 2014
@@ -119,6 +119,10 @@ public class RLoginClient extends RComma
 
     /***
      * Same as the other rlogin method, but no terminal speed is defined.
+     * @param localUsername the local user
+     * @param remoteUsername the remote user
+     * @param terminalType the terminal type
+     * @throws IOException on error
      ***/
     public void rlogin(String localUsername, String remoteUsername,
                        String terminalType)

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/FTPTimestampParserImpl.java
Sun Apr 13 14:18:02 2014
@@ -242,7 +242,7 @@ public class FTPTimestampParserImpl impl
      * by that {@link  FTPClientConfig#lookupDateFormatSymbols(String) language}
      * to parse timestamps.</li>
      * <li>otherwise use default English month names</li>
-     * </ul></p><p>
+     * </ul><p>
      * Finally if a {@link  org.apache.commons.net.ftp.FTPClientConfig#setServerTimeZoneId(String)
serverTimeZoneId}
      * has been supplied via the config, set that into all date formats that have
      * been configured.

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
Sun Apr 13 14:18:02 2014
@@ -255,6 +255,9 @@ public class VMSFTPEntryParser extends C
 
     /**
      * DO NOT USE
+     * @param listStream the stream
+     * @return the array of files
+     * @throws IOException on error
      * @deprecated (2.2) No other FTPFileEntryParser implementations have this method.
      */
     @Deprecated

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java
Sun Apr 13 14:18:02 2014
@@ -74,6 +74,7 @@ public class AuthenticatingIMAPClient ex
      * Constructor for AuthenticatingIMAPClient that delegates to IMAPSClient.
      * @param proto the protocol.
      * @param implicit The security mode(Implicit/Explicit).
+     * @param ctx the context
      */
     public AuthenticatingIMAPClient(String proto, boolean implicit, SSLContext ctx)
     {
@@ -103,6 +104,9 @@ public class AuthenticatingIMAPClient ex
      * Authenticate to the IMAP server by sending the AUTHENTICATE command with the
      * selected mechanism, using the given username and the given password.
      * <p>
+     * @param method the method name
+     * @param username user
+     * @param password password
      * @return True if successfully completed, false if not.
      * @exception IOException  If an I/O error occurs while either sending a
      *      command to the server or receiving a reply from the server.
@@ -125,6 +129,9 @@ public class AuthenticatingIMAPClient ex
      * Authenticate to the IMAP server by sending the AUTHENTICATE command with the
      * selected mechanism, using the given username and the given password.
      * <p>
+     * @param method the method name
+     * @param username user
+     * @param password password
      * @return True if successfully completed, false if not.
      * @exception IOException  If an I/O error occurs while either sending a
      *      command to the server or receiving a reply from the server.

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java Sun Apr 13
14:18:02 2014
@@ -76,6 +76,7 @@ public final class Util
      *        write.  This is necessary for interactive sessions that rely on
      *        buffered streams.  If you don't flush, the data will stay in
      *        the stream buffer.
+     * @return number of bytes read/written
      * @exception CopyStreamException  If an error occurs while reading from the
      *            source or writing to the destination.  The CopyStreamException
      *            will contain the number of bytes confirmed to have been
@@ -162,6 +163,7 @@ public final class Util
      *          Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
      * @param listener  The CopyStreamListener to notify of progress.  If
      *      this parameter is null, notification is not attempted.
+     * @return number of bytes read/written
      * @exception CopyStreamException  If an error occurs while reading from the
      *            source or writing to the destination.  The CopyStreamException
      *            will contain the number of bytes confirmed to have been
@@ -214,6 +216,10 @@ public final class Util
 
     /***
      * Same as <code> copyStream(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code>
+     * @param source where to copy from
+     * @param dest  where to copy to
+     * @return number of bytes copied
+     * @throws CopyStreamException on error
      ***/
     public static final long copyStream(InputStream source, OutputStream dest)
     throws CopyStreamException
@@ -334,6 +340,10 @@ public final class Util
 
     /***
      * Same as <code> copyReader(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code>
+     * @param source where to copy from
+     * @param dest  where to copy to
+     * @return number of bytes copied
+     * @throws CopyStreamException on error
      ***/
     public static final long copyReader(Reader source, Writer dest)
     throws CopyStreamException

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacketException.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacketException.java?rev=1587002&r1=1587001&r2=1587002&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacketException.java
(original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacketException.java
Sun Apr 13 14:18:02 2014
@@ -50,6 +50,7 @@ public class TFTPPacketException extends
 
     /***
      * Simply calls the corresponding constructor of its superclass.
+     * @param message the message
      ***/
     public TFTPPacketException(String message)
     {



Mime
View raw message