You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2014/04/13 14:57:45 UTC
svn commit: r1586975 - in
/commons/proper/net/trunk/src/main/java/org/apache/commons/net: ./ discard/
ftp/ ftp/parser/ nntp/ smtp/ util/
Author: sebb
Date: Sun Apr 13 12:57:45 2014
New Revision: 1586975
URL: http://svn.apache.org/r1586975
Log:
Javadoc fixes (Java 8)
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/DatagramSocketClient.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTP.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/FTPFileEntryParser.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/CompositeFileEntryParser.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Article.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTP.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threadable.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/RelayPath.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/SubnetUtils.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/DatagramSocketClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/DatagramSocketClient.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/DatagramSocketClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/DatagramSocketClient.java Sun Apr 13 12:57:45 2014
@@ -216,6 +216,7 @@ public abstract class DatagramSocketClie
* <p>
* @param timeout The timeout in milliseconds to use for the currently
* open datagram socket connection.
+ * @throws SocketException if an error setting the timeout
***/
public void setSoTimeout(int timeout) throws SocketException
{
@@ -229,6 +230,7 @@ public abstract class DatagramSocketClie
* a NullPointerException is thrown.
* <p>
* @return The timeout in milliseconds of the currently opened socket.
+ * @throws SocketException if an error getting the timeout
***/
public int getSoTimeout() throws SocketException
{
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/PrintCommandListener.java Sun Apr 13 12:57:45 2014
@@ -24,7 +24,6 @@ import java.io.PrintWriter;
* This is a support class for some of the example programs. It is
* a sample implementation of the ProtocolCommandListener interface
* which just prints out to a specified stream all command/reply traffic.
- * <p>
*
* @since 2.0
***/
@@ -82,7 +81,7 @@ public class PrintCommandListener implem
* @param stream where to write the commands and responses
* @param suppressLogin if {@code true}, only print command name for login
* @param eolMarker if non-zero, add a marker just before the EOL.
- * @param showDirection if {@code true}, add "> " or "< " as appropriate to the output
+ * @param showDirection if {@code true}, add {@code "> "} or {@code "< "} as appropriate to the output
*
* @since 3.0
*/
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=1586975&r1=1586974&r2=1586975&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 Sun Apr 13 12:57:45 2014
@@ -147,6 +147,7 @@ public abstract class SocketClient
* Subclasses overriding this method should start by calling
* <code> super._connectAction_() </code> first to ensure the
* initialization of the aforementioned protected variables.
+ * @throws IOException (SocketException) if a problem occurs with the socket
*/
protected void _connectAction_() throws IOException
{
@@ -474,7 +475,7 @@ public abstract class SocketClient
* Set the underlying socket send buffer size.
* <p>
* @param size The size of the buffer in bytes.
- * @throws SocketException
+ * @throws SocketException never thrown, but subclasses might want to do so
* @since 2.0
*/
public void setSendBufferSize(int size) throws SocketException {
@@ -558,7 +559,7 @@ public abstract class SocketClient
* allows a specific keepalive value to be set, although this seems not to be the case on
* other systems.
* @param keepAlive If true, keepAlive is turned on
- * @throws SocketException
+ * @throws SocketException if there is a problem with the socket
* @throws NullPointerException if the socket is not currently open
* @since 2.2
*/
@@ -570,7 +571,7 @@ public abstract class SocketClient
* Returns the current value of the SO_KEEPALIVE flag on the currently opened socket.
* Delegates to {@link Socket#getKeepAlive()}
* @return True if SO_KEEPALIVE is enabled.
- * @throws SocketException
+ * @throws SocketException if there is a problem with the socket
* @throws NullPointerException if the socket is not currently open
* @since 2.2
*/
@@ -666,6 +667,7 @@ public abstract class SocketClient
* accept a connection from a server, such as an FTP data connection or
* a BSD R command standard error stream.
* <p>
+ * @param socket the item to check against
* @return True if the remote hosts are the same, false if not.
*/
public boolean verifyRemote(Socket socket)
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardTCPClient.java Sun Apr 13 12:57:45 2014
@@ -32,7 +32,6 @@ import org.apache.commons.net.SocketClie
* {@link org.apache.commons.net.SocketClient#disconnect disconnect }
* to clean up properly.
* <p>
- * <p>
* @see DiscardUDPClient
***/
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/discard/DiscardUDPClient.java Sun Apr 13 12:57:45 2014
@@ -32,8 +32,7 @@ import org.apache.commons.net.DatagramSo
* After you're done sending discard data, call
* {@link org.apache.commons.net.DatagramSocketClient#close close() }
* to clean up properly.
- * <p>
- * <p>
+ *
* @see DiscardTCPClient
***/
@@ -75,6 +74,11 @@ public class DiscardUDPClient extends Da
/***
* Same as
* <code>send(data, length, host. DiscardUDPClient.DEFAULT_PORT)</code>.
+ * @param data the buffer to send
+ * @param length the length of the data in the buffer
+ * @param host the target host
+ * @see #send(byte[], int, InetAddress, int)
+ * @throws IOException if an error occurs
***/
public void send(byte[] data, int length, InetAddress host)
throws IOException
@@ -86,6 +90,10 @@ public class DiscardUDPClient extends Da
/***
* Same as
* <code>send(data, data.length, host. DiscardUDPClient.DEFAULT_PORT)</code>.
+ * @param data the buffer to send
+ * @param host the target host
+ * @see #send(byte[], int, InetAddress, int)
+ * @throws IOException if an error occurs
***/
public void send(byte[] data, InetAddress host) throws IOException
{
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTP.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTP.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTP.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTP.java Sun Apr 13 12:57:45 2014
@@ -939,12 +939,10 @@ public class FTP extends SocketClient
* receive the reply, and return the reply code.
*
* Examples:
- * <code>
* <ul>
* <li>EPRT |1|132.235.1.2|6275|</li>
* <li>EPRT |2|1080::8:800:200C:417A|5282|</li>
* </ul>
- * </code>
* <p>
* @see "http://www.faqs.org/rfcs/rfc2428.html"
*
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=1586975&r1=1586974&r2=1586975&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 Sun Apr 13 12:57:45 2014
@@ -239,14 +239,14 @@ import org.apache.commons.net.io.Util;
* as in Ant</li>
* </ul>see {@link FTPClientConfig FTPClientConfig}.
* <p>
- * <b>Control channel keep-alive feature</b>:<br/>
+ * <b>Control channel keep-alive feature</b>:<br>
* During file transfers, the data connection is busy, but the control connection is idle.
* FTP servers know that the control connection is in use, so won't close it through lack of activity,
* but it's a lot harder for network routers to know that the control and data connections are associated
* with each other.
* Some routers may treat the control connection as idle, and disconnect it if the transfer over the data
* connection takes longer than the allowable idle time for the router.
- * <br/>
+ * <br>
* One solution to this is to send a safe command (i.e. NOOP) over the control connection to reset the router's
* idle timer. This is enabled as follows:
* <pre>
@@ -278,7 +278,7 @@ public class FTPClient extends FTP
implements Configurable
{
/**
- * The system property ({@value}) which can be used to override the system type.<br/>
+ * The system property ({@value}) which can be used to override the system type.<br>
* If defined, the value will be used to create any automatically created parsers.
*
* @since 3.0
@@ -286,7 +286,7 @@ implements Configurable
public static final String FTP_SYSTEM_TYPE = "org.apache.commons.net.ftp.systemType";
/**
- * The system property ({@value}) which can be used as the default system type.<br/>
+ * The system property ({@value}) which can be used as the default system type.<br>
* If defined, the value will be used if the SYST command fails.
*
* @since 3.1
@@ -295,10 +295,10 @@ implements Configurable
/**
* The name of an optional systemType properties file ({@value}), which is loaded
- * using {@link Class#getResourceAsStream(String)}.<br/>
+ * using {@link Class#getResourceAsStream(String)}.<br>
* The entries are the systemType (as determined by {@link FTPClient#getSystemType})
* and the values are the replacement type or parserClass, which is passed to
- * {@link FTPFileEntryParserFactory#createFileEntryParser(String)}.<br/>
+ * {@link FTPFileEntryParserFactory#createFileEntryParser(String)}.<br>
* For example:
* <pre>
* Plan 9=Unix
@@ -2220,13 +2220,13 @@ implements Configurable
* Query the server for supported features. The server may reply with a list of server-supported exensions.
* For example, a typical client-server interaction might be (from RFC 2389):
* <pre>
- C> feat
- S> 211-Extensions supported:
- S> MLST size*;create;modify*;perm;media-type
- S> SIZE
- S> COMPRESSION
- S> MDTM
- S> 211 END
+ C> feat
+ S> 211-Extensions supported:
+ S> MLST size*;create;modify*;perm;media-type
+ S> SIZE
+ S> COMPRESSION
+ S> MDTM
+ S> 211 END
* </pre>
* @see <a href="http://www.faqs.org/rfcs/rfc2389.html">http://www.faqs.org/rfcs/rfc2389.html</a>
* @return True if successfully completed, false if not.
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileEntryParser.java Sun Apr 13 12:57:45 2014
@@ -45,7 +45,7 @@ import java.util.List;
* FTPFile[] files = f.listFiles("subfolder");
* </pre>
*
- * The secondr example uses the <code>FTPClient.listFiles()</code>>
+ * The second example uses the <code>FTPClient.listFiles()</code>
* API to pull the whole list from the current working directory in one call,
* but specifying by classname the parser to be used. For this particular
* parser class, this approach is necessary since there is no way to
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/CompositeFileEntryParser.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/CompositeFileEntryParser.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/CompositeFileEntryParser.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/CompositeFileEntryParser.java Sun Apr 13 12:57:45 2014
@@ -28,7 +28,7 @@ import org.apache.commons.net.ftp.FTPFil
* If the cached parser wont match due to the server changed the dirstyle,
* a new matching parser will be searched.
*
- * @author Mario Ivankovits <ma...@ops.co.at>
+ * @author Mario Ivankovits (mario@ops.co.at)
*/
public class CompositeFileEntryParser extends FTPFileEntryParserImpl
{
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/DefaultFTPFileEntryParserFactory.java Sun Apr 13 12:57:45 2014
@@ -54,7 +54,7 @@ public class DefaultFTPFileEntryParserFa
* object of this class is instantiated and is returned;
* otherwise it attempts to interpret the key as an identirier
* commonly used by the FTP SYST command to identify systems.
- * <p/>
+ * <p>
* If <code>key</code> is not recognized as a fully qualified
* classname known to the system, this method will then attempt
* to see whether it <b>contains</b> a string identifying one of
@@ -63,11 +63,11 @@ public class DefaultFTPFileEntryParserFa
* which are returned by the SYST command on the systems which
* the corresponding parser successfully parses. This enables
* this factory to be used in the auto-detection system.
- * <p/>
+ * <p>
*
* @param key should be a fully qualified classname corresponding to
- * a class implementing the FTPFileEntryParser interface<br/>
- * OR<br/>
+ * a class implementing the FTPFileEntryParser interface<br>
+ * OR<br>
* a string containing (case-insensitively) one of the
* following keywords:
* <ul>
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java Sun Apr 13 12:57:45 2014
@@ -38,7 +38,7 @@ import org.apache.commons.net.ftp.FTPFil
* "Type" / "Unique" / "Perm" /
* "Lang" / "Media-Type" / "CharSet" /
* os-depend-fact / local-fact
- * os-depend-fact = <IANA assigned OS name> "." token
+ * os-depend-fact = {IANA assigned OS name} "." token
* local-fact = "X." token
* value = *SCHAR
*
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/OS400FTPEntryParser.java Sun Apr 13 12:57:45 2014
@@ -30,10 +30,10 @@ import org.apache.commons.net.ftp.FTPFil
* working directory is a file of file system QSYS:
* ------------------------------------------------
*
- * > cwd /qsys.lib/rpgunit.lib/rpgunitc1.file
+ * $ cwd /qsys.lib/rpgunit.lib/rpgunitc1.file
* 250-NAMEFMT set to 1.
* 250 "/QSYS.LIB/RPGUNIT.LIB/RPGUNITC1.FILE" is current directory.
- * > dir
+ * $ dir
* 227 Entering Passive Mode (10,200,36,33,40,249).
* 125 List started.
* QPGMR 135168 22.06.13 13:18:19 *FILE
@@ -47,9 +47,9 @@ import org.apache.commons.net.ftp.FTPFil
* Example *FILE entry of an OS/400 save file:
* ---------------------------------------------------
*
- * > cwd /qsys.lib/rpgunit.lib
+ * $ cwd /qsys.lib/rpgunit.lib
* 250 "/QSYS.LIB/RPGUNIT.LIB" is current library.
- * > dir rpgunit.file
+ * $ dir rpgunit.file
* 227 Entering Passive Mode (10,200,36,33,188,106).
* 125 List started.
* QPGMR 16347136 29.06.13 15:45:09 *FILE RPGUNIT.SAVF
@@ -60,9 +60,9 @@ import org.apache.commons.net.ftp.FTPFil
* current working directory is in file system "root":
* ---------------------------------------------------
*
- * > cwd /home/raddatz
+ * $ cwd /home/raddatz
* 250 "/home/raddatz" is current directory.
- * > dir test*
+ * $ dir test*
* 227 Entering Passive Mode (10,200,36,33,200,189).
* 125 List started.
* RADDATZ 200 21.05.11 12:31:18 *STMF TEST_RG_02_CRLF.properties
@@ -76,8 +76,8 @@ import org.apache.commons.net.ftp.FTPFil
* Example 1, using ANT to list specific members of a file:
* --------------------------------------------------------
*
- * <echo/>
- * <echo>Listing members of a file:</echo>
+ * <echo/>
+ * <echo>Listing members of a file:</echo>
*
* <ftp action="list"
* server="${ftp.server}"
@@ -88,11 +88,11 @@ import org.apache.commons.net.ftp.FTPFil
* remotedir="/QSYS.LIB/RPGUNIT.LIB/RPGUNITY1.FILE"
* systemTypeKey="OS/400"
* listing="ftp-listing.txt"
- * >
+ * >
* <fileset dir="./i5-downloads-file" casesensitive="false">
- * <include name="run*.mbr" />
- * </fileset>
- * </ftp>
+ * <include name="run*.mbr" />
+ * </fileset>
+ * </ftp>
*
* Output:
* -------
@@ -108,8 +108,8 @@ import org.apache.commons.net.ftp.FTPFil
* Example 2, using ANT to list specific members of all files of a library:
* ------------------------------------------------------------------------
*
- * <echo/>
- * <echo>Listing members of all files of a library:</echo>
+ * <echo/>
+ * <echo>Listing members of all files of a library:</echo>
*
* <ftp action="list"
* server="${ftp.server}"
@@ -120,11 +120,11 @@ import org.apache.commons.net.ftp.FTPFil
* remotedir="/QSYS.LIB/RPGUNIT.LIB"
* systemTypeKey="OS/400"
* listing="ftp-listing.txt"
- * >
- * <fileset dir="./i5-downloads-lib" casesensitive="false">
+ * >
+ * <fileset dir="./i5-downloads-lib" casesensitive="false">
* <include name="**\run*.mbr" />
- * </fileset>
- * </ftp>
+ * </fileset>
+ * </ftp>
*
* Output:
* -------
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Article.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Article.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Article.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Article.java Sun Apr 13 12:57:45 2014
@@ -21,8 +21,8 @@ import java.util.ArrayList;
/**
* This is a class that contains the basic state needed for message retrieval and threading.
- * With thanks to Jamie Zawinski <jw...@jwz.org>
- * @author rwinston <rw...@apache.org>
+ * With thanks to Jamie Zawinski (jwz@jwz.org)
+ * @author rwinston (rwinston@apache.org)
*/
public class Article implements Threadable {
private long articleNumber;
@@ -42,7 +42,7 @@ public class Article implements Threadab
/**
* Adds a message-id to the list of messages that this message references (i.e. replies to)
- * @param msgId
+ * @param msgId the message id to add
*/
public void addReference(String msgId) {
if (msgId == null || msgId.length() == 0) {
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/ArticlePointer.java Sun Apr 13 12:57:45 2014
@@ -33,7 +33,7 @@ public final class ArticlePointer
public int articleNumber;
/**
* The unique id of the referenced article, including the enclosing
- * < and > symbols which are technically not part of the
+ * < and > symbols which are technically not part of the
* identifier, but are required by all NNTP commands taking an
* article id as an argument.
*/
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTP.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTP.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTP.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTP.java Sun Apr 13 12:57:45 2014
@@ -71,8 +71,7 @@ import org.apache.commons.net.io.CRLFLin
* the reply received from the server deviates enough from the protocol
* specification that it cannot be interpreted in a useful manner despite
* attempts to be as lenient as possible.
- * <p>
- * <p>
+ *
* @author Rory Winston
* @author Ted Wise
* @see NNTPClient
@@ -388,7 +387,7 @@ public class NNTP extends SocketClient
* receive the initial reply, and return the reply code.
* <p>
* @param messageId The message identifier of the requested article,
- * including the encapsulating < and > characters.
+ * including the encapsulating < and > characters.
* @return The reply code received from the server.
* @exception NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
@@ -448,7 +447,7 @@ public class NNTP extends SocketClient
* receive the initial reply, and return the reply code.
* <p>
* @param messageId The message identifier of the requested article,
- * including the encapsulating < and > characters.
+ * including the encapsulating < and > characters.
* @return The reply code received from the server.
* @exception NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
@@ -508,7 +507,7 @@ public class NNTP extends SocketClient
* receive the initial reply, and return the reply code.
* <p>
* @param messageId The message identifier of the requested article,
- * including the encapsulating < and > characters.
+ * including the encapsulating < and > characters.
* @return The reply code received from the server.
* @exception NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
@@ -568,7 +567,7 @@ public class NNTP extends SocketClient
* receive the initial reply, and return the reply code.
* <p>
* @param messageId The message identifier of the requested article,
- * including the encapsulating < and > characters.
+ * including the encapsulating < and > characters.
* @return The reply code received from the server.
* @exception NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
@@ -666,7 +665,7 @@ public class NNTP extends SocketClient
* receive the reply, and return the reply code.
* <p>
* @param messageId The article identifier,
- * including the encapsulating < and > characters.
+ * including the encapsulating < and > characters.
* @return The reply code received from the server.
* @exception NNTPConnectionClosedException
* If the NNTP server prematurely closes the connection as a result
@@ -978,7 +977,7 @@ public class NNTP extends SocketClient
* @param wildmat A wildmat (pseudo-regex) pattern. See RFC 2980 for
* details.
* @return the reply code received from the server.
- * @throws IOException
+ * @throws IOException if the command fails
*/
public int listActive(String wildmat) throws IOException {
StringBuilder command = new StringBuilder("ACTIVE ");
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPClient.java Sun Apr 13 12:57:45 2014
@@ -323,7 +323,7 @@ public class NNTPClient extends NNTP
/***
* Retrieves an article from the NNTP server. The article is referenced
- * by its unique article identifier (including the enclosing < and >).
+ * by its unique article identifier (including the enclosing < and >).
* The article number and identifier contained in the server reply
* are returned through an ArticleInfo. The <code> articleId </code>
* field of the ArticleInfo cannot always be trusted because some
@@ -370,6 +370,9 @@ public class NNTPClient extends NNTP
/**
* Same as <code> retrieveArticle(articleId, (ArticleInfo) null) </code>
* Note: the return can be cast to a {@link BufferedReader}
+ * @param articleId the article id to retrieve
+ * @return the reader
+ * @throws IOException if an IO error occurs
*/
public Reader retrieveArticle(String articleId) throws IOException
{
@@ -379,6 +382,8 @@ public class NNTPClient extends NNTP
/**
* Same as <code> retrieveArticle((String) null) </code>
* Note: the return can be cast to a {@link BufferedReader}
+ * @return the reader
+ * @throws IOException if an IO error occurs
*/
public Reader retrieveArticle() throws IOException
{
@@ -430,7 +435,12 @@ public class NNTPClient extends NNTP
return __retrieve(NNTPCommand.ARTICLE, articleNumber, pointer);
}
- /*** Same as <code> retrieveArticle(articleNumber, null) </code> ***/
+ /**
+ * Same as <code> retrieveArticle(articleNumber, null) </code>
+ * @param articleNumber the article number to fetch
+ * @return the reader
+ * @throws IOException if an IO error occurs
+ */
public BufferedReader retrieveArticle(long articleNumber) throws IOException
{
return retrieveArticle(articleNumber, null);
@@ -441,7 +451,7 @@ public class NNTPClient extends NNTP
/***
* Retrieves an article header from the NNTP server. The article is
* referenced
- * by its unique article identifier (including the enclosing < and >).
+ * by its unique article identifier (including the enclosing < and >).
* The article number and identifier contained in the server reply
* are returned through an ArticleInfo. The <code> articleId </code>
* field of the ArticleInfo cannot always be trusted because some
@@ -488,6 +498,8 @@ public class NNTPClient extends NNTP
/**
* Same as <code> retrieveArticleHeader(articleId, (ArticleInfo) null) </code>
* Note: the return can be cast to a {@link BufferedReader}
+ * @param articleId the article id to fetch
+ * @return the reader
*/
public Reader retrieveArticleHeader(String articleId) throws IOException
{
@@ -561,7 +573,7 @@ public class NNTPClient extends NNTP
/***
* Retrieves an article body from the NNTP server. The article is
* referenced
- * by its unique article identifier (including the enclosing < and >).
+ * by its unique article identifier (including the enclosing < and >).
* The article number and identifier contained in the server reply
* are returned through an ArticleInfo. The <code> articleId </code>
* field of the ArticleInfo cannot always be trusted because some
@@ -765,7 +777,7 @@ public class NNTPClient extends NNTP
/***
* Select an article by its unique identifier (including enclosing
- * < and >) and return its article number and id through the
+ * < and >) and return its article number and id through the
* pointer parameter. This is achieved through the STAT command.
* According to RFC 977, this will NOT set the current article pointer
* on the server. To do that, you must reference the article by its
@@ -1185,7 +1197,7 @@ public class NNTPClient extends NNTP
* command fails, null will be returned. You must add at least one
* newsgroup to the query, else the command will fail. Each String
* in the returned array is a unique message identifier including the
- * enclosing < and >.
+ * enclosing < and >.
* This uses the "NEWNEWS" command.
* <p>
* @param query The query restricting how to search for new news. You
@@ -1243,7 +1255,7 @@ public class NNTPClient extends NNTP
* This uses the "NEWNEWS" command.
* You must add at least one newsgroup to the query, else the command will fail.
* Each String which is returned is a unique message identifier including the
- * enclosing < and >.
+ * enclosing < and >.
* <p>
* @param query The query restricting how to search for new news. You
* must add at least one newsgroup to the query.
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewGroupsOrNewsQuery.java Sun Apr 13 12:57:45 2014
@@ -36,8 +36,7 @@ import java.util.Calendar;
* </pre>
* This will retrieve the list of newsgroups starting with the comp.
* distribution prefix created since midnight 11/15/97.
- * <p>
- * <p>
+ *
* @see NNTPClient
***/
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NewsgroupInfo.java Sun Apr 13 12:57:45 2014
@@ -26,8 +26,7 @@ package org.apache.commons.net.nntp;
* , and
* {@link org.apache.commons.net.nntp.NNTPClient#listNewNewsgroups listNewNewsgroups }
* respectively.
- * <p>
- * <p>
+ *
* @see NNTPClient
***/
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threadable.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threadable.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threadable.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threadable.java Sun Apr 13 12:57:45 2014
@@ -19,7 +19,7 @@ package org.apache.commons.net.nntp;
/**
* A placeholder interface for threadable message objects
- * Author: Rory Winston <rw...@checkfree.com>
+ * Author: Rory Winston (rwinston@checkfree.com)
*
*/
public interface Threadable {
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/RelayPath.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/RelayPath.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/RelayPath.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/smtp/RelayPath.java Sun Apr 13 12:57:45 2014
@@ -50,7 +50,7 @@ public final class RelayPath
/***
* Add a mail relay host to the relay path. Hosts are added left to
* right. For example, the following will create the path
- * <code><b> < @bar.com,@foo.com:foobar@foo.com > </b></code>
+ * <code><b> < @bar.com,@foo.com:foobar@foo.com > </b></code>
* <pre>
* path = new RelayPath("foobar@foo.com");
* path.addRelay("bar.com");
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Base64.java Sun Apr 13 12:57:45 2014
@@ -255,7 +255,7 @@ public class Base64 {
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
- * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+ * If {@code lineLength <= 0}, then the output will not be divided into lines (chunks). Ignored when decoding.
* @since 1.4
*/
public Base64(int lineLength) {
@@ -277,7 +277,7 @@ public class Base64 {
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
- * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+ * If {@code lineLength <= 0}, then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
* @throws IllegalArgumentException
@@ -303,7 +303,7 @@ public class Base64 {
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
- * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+ * If {@code lineLength <= 0}, then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
* @param urlSafe
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/KeyManagerUtils.java Sun Apr 13 12:57:45 2014
@@ -49,7 +49,7 @@ import org.apache.commons.net.io.Util;
* cl.connect(...);
* </pre>
* If using the default store type and the key password is the same as the
- * store password, these parameters can be omitted. <br/>
+ * store password, these parameters can be omitted. <br>
* If the desired key is the first or only key in the keystore, the keyAlias parameter
* can be omitted, in which case the code becomes:
* <pre>
@@ -78,6 +78,7 @@ public final class KeyManagerUtils {
* @param keyAlias the alias of the key to use, may be {@code null} in which case the first key entry alias is used
* @param keyPass the password of the key to use
* @return the customised KeyManager
+ * @throws GeneralSecurityException if there is a problem creating the keystore
*/
public static KeyManager createClientKeyManager(KeyStore ks, String keyAlias, String keyPass)
throws GeneralSecurityException
@@ -96,6 +97,8 @@ public final class KeyManagerUtils {
* @param keyAlias the alias of the key to use, may be {@code null} in which case the first key entry alias is used
* @param keyPass the password of the key to use
* @return the customised KeyManager
+ * @throws GeneralSecurityException if there is a problem creating the keystore
+ * @throws IOException if there is a problem creating the keystore
*/
public static KeyManager createClientKeyManager(String storeType, File storePath, String storePass, String keyAlias, String keyPass)
throws IOException, GeneralSecurityException
@@ -113,6 +116,8 @@ public final class KeyManagerUtils {
* @param storePass the keyStore password
* @param keyAlias the alias of the key to use, may be {@code null} in which case the first key entry alias is used
* @return the customised KeyManager
+ * @throws IOException if there is a problem creating the keystore
+ * @throws GeneralSecurityException if there is a problem creating the keystore
*/
public static KeyManager createClientKeyManager(File storePath, String storePass, String keyAlias)
throws IOException, GeneralSecurityException
@@ -129,6 +134,8 @@ public final class KeyManagerUtils {
* @param storePath the path to the keyStore
* @param storePass the keyStore password
* @return the customised KeyManager
+ * @throws IOException if there is a problem creating the keystore
+ * @throws GeneralSecurityException if there is a problem creating the keystore
*/
public static KeyManager createClientKeyManager(File storePath, String storePass)
throws IOException, GeneralSecurityException
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/SubnetUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/SubnetUtils.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/SubnetUtils.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/SubnetUtils.java Sun Apr 13 12:57:45 2014
@@ -22,7 +22,7 @@ import java.util.regex.Pattern;
/**
* A class that performs some subnet calculations given a network address and a subnet mask.
* @see "http://www.faqs.org/rfcs/rfc1519.html"
- * @author <rw...@apache.org>
+ * @author rwinston@apache.org
* @since 2.0
*/
public class SubnetUtils {
@@ -66,8 +66,9 @@ public class SubnetUtils {
/**
* Returns <code>true</code> if the return value of {@link SubnetInfo#getAddressCount()}
- * includes the network address and broadcast addresses.
+ * includes the network and broadcast addresses.
* @since 2.2
+ * @return true if the hostcount includes the network and broadcast addresses
*/
public boolean isInclusiveHostCount() {
return inclusiveHostCount;
@@ -76,7 +77,7 @@ public class SubnetUtils {
/**
* Set to <code>true</code> if you want the return value of {@link SubnetInfo#getAddressCount()}
* to include the network and broadcast addresses.
- * @param inclusiveHostCount
+ * @param inclusiveHostCount true if network and broadcast addresses are to be included
* @since 2.2
*/
public void setInclusiveHostCount(boolean inclusiveHostCount) {
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java?rev=1586975&r1=1586974&r2=1586975&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/TrustManagerUtils.java Sun Apr 13 12:57:45 2014
@@ -104,7 +104,7 @@ public final class TrustManagerUtils
* when the TrustManager parameter is set to {@code null}
* @param keyStore the KeyStore to use, may be {@code null}
* @return the default TrustManager
- * @throws GeneralSecurityException
+ * @throws GeneralSecurityException if an error occurs
*/
public static X509TrustManager getDefaultTrustManager(KeyStore keyStore) throws GeneralSecurityException {
String defaultAlgorithm = TrustManagerFactory.getDefaultAlgorithm();