Author: sebb
Date: Sun Jan 18 21:26:41 2015
New Revision: 1652855
URL: http://svn.apache.org/r1652855
Log:
Javadoc 8 fixes
Modified:
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/FTPListParseEngine.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSClient.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/imap/IMAP.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPReply.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/io/FromNetASCIIInputStream.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/ntp/NtpUtils.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Command.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/Telnet.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
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=1652855&r1=1652854&r2=1652855&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 Jan 18 21:26:41 2015
@@ -298,6 +298,7 @@ public class FTP extends SocketClient
* Get the reply, but don't pass it to command listeners.
* Used for keep-alive processing only.
* @since 3.0
+ * @throws IOException on error
*/
protected void __getReplyNoReport() throws IOException
{
@@ -534,7 +535,7 @@ public class FTP extends SocketClient
* Send a noop and get the reply without reporting to the command listener.
* Intended for use with keep-alive.
*
- * @throws IOException
+ * @throws IOException on error
* @since 3.0
*/
protected void __noop() throws 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=1652855&r1=1652854&r2=1652855&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 Jan 18 21:26:41 2015
@@ -555,6 +555,8 @@ implements Configurable
/**
* @since 3.1
+ * @param reply the reply to parse
+ * @throws MalformedServerReplyException if the server reply does not
match (n,n,n,n),(n),(n)
*/
protected void _parsePassiveModeReply(String reply)
throws MalformedServerReplyException
@@ -642,6 +644,11 @@ implements Configurable
/**
* @since 3.1
+ * @param command the command to send
+ * @param remote the remote file name
+ * @param local the local file name
+ * @return true if successful
+ * @throws IOException on error
*/
protected boolean _storeFile(String command, String remote, InputStream
local)
throws IOException
@@ -698,6 +705,10 @@ implements Configurable
}
/**
+ * @param command the command to send
+ * @param remote the remote file name
+ * @return the output stream to write to
+ * @throws IOException on error
* @since 3.1
*/
protected OutputStream _storeFileStream(String command, String remote)
@@ -1871,6 +1882,11 @@ implements Configurable
}
/**
+ * @param command the command to get
+ * @param remote the remote file name
+ * @param local the local file name
+ * @return true if successful
+ * @throws IOException on error
* @since 3.1
*/
protected boolean _retrieveFile(String command, String remote,
OutputStream local)
@@ -1948,6 +1964,10 @@ implements Configurable
}
/**
+ * @param command the command to send
+ * @param remote the remote file name
+ * @return the stream from which to read the file
+ * @throws IOException on error
* @since 3.1
*/
protected InputStream _retrieveFileStream(String command, String remote)
@@ -3416,6 +3436,8 @@ implements Configurable
}
/**
+ * @param pathname the initial pathname
+ * @return the adjusted string with "-a" added if necessary
* @since 2.0
*/
protected String getListArguments(String pathname) {
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPListParseEngine.java
Sun Jan 18 21:26:41 2015
@@ -315,6 +315,8 @@ public class FTPListParseEngine {
/**
* Do not use.
+ * @param stream the stream from which to read
+ * @throws IOException on error
* @deprecated use {@link #readServerList(InputStream, String)} instead
*/
@Deprecated
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSClient.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSClient.java
Sun Jan 18 21:26:41 2015
@@ -629,7 +629,8 @@ public class FTPSClient extends FTPClien
* Called by {@link #_openDataConnection_(int, String)} immediately
* after creating the socket.
* The default implementation is a no-op
- * @throws IOException
+ * @param socket the socket to set up
+ * @throws IOException on error
* @since 3.1
*/
protected void _prepareDataSocket_(Socket socket)
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=1652855&r1=1652854&r2=1652855&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 Jan 18 21:26:41 2015
@@ -181,8 +181,8 @@ public class FTPTimestampParserImpl impl
* @see FTPTimestampParser#parseTimestamp(String)
* @param timestampStr The timestamp to be parsed
* @param serverTime The current time for the server
- * @return
- * @throws ParseException
+ * @return the calendar
+ * @throws ParseException if timestamp cannot be parsed
* @since 1.5
*/
public Calendar parseTimestamp(String timestampStr, Calendar serverTime)
throws ParseException {
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAP.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAP.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAP.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAP.java
Sun Jan 18 21:26:41 2015
@@ -310,6 +310,7 @@ public class IMAP extends SocketClient
* @param command The IMAP command to send.
* @param args The command arguments.
* @return The server reply code (see IMAPReply).
+ * @throws IOException on error
*/
public int sendCommand(String command, String args) throws IOException
{
@@ -322,6 +323,7 @@ public class IMAP extends SocketClient
*
* @param command The IMAP command to send.
* @return The server reply code (see IMAPReply).
+ * @throws IOException on error
*/
public int sendCommand(String command) throws IOException
{
@@ -335,6 +337,7 @@ public class IMAP extends SocketClient
* (one of the IMAPCommand constants).
* @param args The command arguments.
* @return The server reply code (see IMAPReply).
+ * @throws IOException on error
*/
public int sendCommand(IMAPCommand command, String args) throws IOException
{
@@ -348,6 +351,7 @@ public class IMAP extends SocketClient
* (one of the IMAPCommand constants).
* @param args The command arguments.
* @return {@code true} if the command was successful
+ * @throws IOException on error
*/
public boolean doCommand(IMAPCommand command, String args) throws
IOException
{
@@ -361,6 +365,7 @@ public class IMAP extends SocketClient
* @param command The IMAP command to send
* (one of the IMAPCommand constants).
* @return The server reply code (see IMAPReply).
+ * @throws IOException on error
**/
public int sendCommand(IMAPCommand command) throws IOException
{
@@ -373,6 +378,7 @@ public class IMAP extends SocketClient
* @param command The IMAP command to send
* (one of the IMAPCommand constants).
* @return {@code true} if the command was successful
+ * @throws IOException on error
*/
public boolean doCommand(IMAPCommand command) throws IOException
{
@@ -384,6 +390,7 @@ public class IMAP extends SocketClient
*
* @param command The IMAP command to send.
* @return The server reply code (see IMAPReply).
+ * @throws IOException on error
*/
public int sendData(String command) throws IOException
{
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPReply.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPReply.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPReply.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPReply.java
Sun Jan 18 21:26:41 2015
@@ -107,6 +107,7 @@ public final class IMAPReply
/**
* Checks if the line introduces a literal, i.e. ends with {dd}
+ * @param line the line to check
*
* @return the literal count, or -1 if there was no literal.
*/
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=1652855&r1=1652854&r2=1652855&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
Sun Jan 18 21:26:41 2015
@@ -114,6 +114,7 @@ public class IMAPSClient extends IMAPCli
* Constructor for IMAPSClient.
* @param proto the protocol.
* @param implicit The security mode(Implicit/Explicit).
+ * @param ctx the SSL context
*/
public IMAPSClient(String proto, boolean implicit, SSLContext ctx)
{
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/FromNetASCIIInputStream.java
Sun Jan 18 21:26:41 2015
@@ -67,6 +67,7 @@ public final class FromNetASCIIInputStre
/***
* Creates a FromNetASCIIInputStream instance that wraps an existing
* InputStream.
+ * @param input the stream to wrap
***/
public FromNetASCIIInputStream(InputStream input)
{
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=1652855&r1=1652854&r2=1652855&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 Jan 18 21:26:41 2015
@@ -1595,7 +1595,7 @@ public class NNTPClient extends NNTP
/**
- * @param header
+ * @param header the header
* @param lowArticleNumber to fetch
* @param highArticleNumber to fetch
* @return a DotTerminatedReader if successful, null otherwise
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpUtils.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpUtils.java
Sun Jan 18 21:26:41 2015
@@ -56,7 +56,7 @@ public final class NtpUtils {
* For details refer to the <A
HREF="http://www.eecis.udel.edu/~mills/ntp/html/refclock.html#list";>Comprehensive
* List of Clock Drivers</A>.
*
- * @param message
+ * @param message the message to check
* @return reference clock string if primary NTP server
*/
public static String getReferenceClock(NtpV3Packet message) {
@@ -86,7 +86,7 @@ public final class NtpUtils {
/***
* Return human-readable name of message mode type (RFC 1305).
*
- * @param mode
+ * @param mode the mode type
* @return mode name
*/
public static String getModeName(int mode)
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Impl.java
Sun Jan 18 21:26:41 2015
@@ -87,7 +87,7 @@ public class NtpV3Impl implements NtpV3P
/***
* Set mode as defined in RFC-1305.
*
- * @param mode
+ * @param mode the mode to set
*/
// @Override
public void setMode(int mode)
@@ -162,7 +162,7 @@ public class NtpV3Impl implements NtpV3P
/***
* Set precision as defined in RFC-1305.
- * @param precision
+ * @param precision the precision to set
*/
public void setPrecision(int precision)
{
@@ -647,7 +647,7 @@ public class NtpV3Impl implements NtpV3P
* Java only has signed types so we have to do
* more work to get unsigned ops.
*
- * @param b
+ * @param b input byte
* @return unsigned int value of byte
*/
protected final static int ui(byte b)
@@ -661,7 +661,7 @@ public class NtpV3Impl implements NtpV3P
* Java only has signed types so we have to do
* more work to get unsigned ops
*
- * @param b
+ * @param b input byte
* @return unsigned long value of byte
*/
protected final static long ul(byte b)
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
Sun Jan 18 21:26:41 2015
@@ -72,6 +72,7 @@ public interface NtpV3Packet
/**
* Set the contents of this object from the datagram packet
+ * @param dp the packet
*/
public void setDatagramPacket(DatagramPacket dp);
@@ -98,6 +99,7 @@ public interface NtpV3Packet
/**
* Set mode as defined in RFC-1305
+ * @param mode the mode to set
*/
public void setMode(int mode);
@@ -110,6 +112,7 @@ public interface NtpV3Packet
/**
* Set poll interval as defined in RFC-1305.
* Field range between NTP_MINPOLL and NTP_MAXPOLL.
+ * @param poll the interval to set
*/
public void setPoll(int poll);
@@ -131,7 +134,7 @@ public interface NtpV3Packet
/**
* Set root delay as defined in RFC-1305
- * @param delay
+ * @param delay the delay to set
*/
void setRootDelay(int delay);
@@ -147,9 +150,9 @@ public interface NtpV3Packet
/**
*
- * @param disperson
+ * @param dispersion the value to set
*/
- void setRootDispersion(int disperson);
+ void setRootDispersion(int dispersion);
/**
* @return root dispersion in milliseconds
@@ -168,6 +171,7 @@ public interface NtpV3Packet
/**
* Set version as defined in RFC-1305
+ * @param version the version to set
*/
public void setVersion(int version);
@@ -178,6 +182,7 @@ public interface NtpV3Packet
/**
* Set stratum as defined in RFC-1305
+ * @param stratum the stratum to set
*/
public void setStratum(int stratum);
@@ -193,7 +198,7 @@ public interface NtpV3Packet
/**
* Set reference clock identifier field.
- * @param refId
+ * @param refId the clock id field to set
*/
public void setReferenceId(int refId);
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeInfo.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeInfo.java
Sun Jan 18 21:26:41 2015
@@ -116,7 +116,7 @@ public class TimeInfo {
* with processing of NTP parameters. If comment list not create
* then one will be created.
*
- * @param comment
+ * @param comment the comment
*/
public void addComment(String comment)
{
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ntp/TimeStamp.java
Sun Jan 18 21:26:41 2015
@@ -88,6 +88,7 @@ public class TimeStamp implements java.i
/***
* Constructs a newly allocated NTP timestamp object
* that represents the native 64-bit long argument.
+ * @param ntpTime the timestamp
*/
public TimeStamp(long ntpTime)
{
@@ -98,12 +99,13 @@ public class TimeStamp implements java.i
* Constructs a newly allocated NTP timestamp object
* that represents the value represented by the string
* in hexdecimal form (e.g. "c1a089bd.fc904f6d").
+ * @param hexStamp the hex timestamp
*
* @throws NumberFormatException - if the string does not contain a
parsable timestamp.
*/
- public TimeStamp(String s) throws NumberFormatException
+ public TimeStamp(String hexStamp) throws NumberFormatException
{
- ntpTime = decodeNtpHexString(s);
+ ntpTime = decodeNtpHexString(hexStamp);
}
/***
@@ -238,26 +240,27 @@ public class TimeStamp implements java.i
/***
* Convert NTP timestamp hexstring (e.g. "c1a089bd.fc904f6d") to the NTP
* 64-bit unsigned fixed-point number.
+ * @param hexString the string to convert
*
* @return NTP 64-bit timestamp value.
* @throws NumberFormatException - if the string does not contain a
parsable timestamp.
*/
- protected static long decodeNtpHexString(String s)
+ protected static long decodeNtpHexString(String hexString)
throws NumberFormatException
{
- if (s == null) {
+ if (hexString == null) {
throw new NumberFormatException("null");
}
- int ind = s.indexOf('.');
+ int ind = hexString.indexOf('.');
if (ind == -1) {
- if (s.length() == 0) {
+ if (hexString.length() == 0) {
return 0;
}
- return Long.parseLong(s, 16) << 32; // no decimal
+ return Long.parseLong(hexString, 16) << 32; // no decimal
}
- return Long.parseLong(s.substring(0, ind), 16) << 32 |
- Long.parseLong(s.substring(ind + 1), 16);
+ return Long.parseLong(hexString.substring(0, ind), 16) << 32 |
+ Long.parseLong(hexString.substring(ind + 1), 16);
}
/***
@@ -373,6 +376,7 @@ public class TimeStamp implements java.i
* The NTP timestamp value is represented as hex string with
* seconds separated by fractional seconds by a decimal point;
* e.g. c1a089bd.fc904f6d == Tue, Dec 10 2002 10:41:49.986
+ * @param ntpTime the 64 bit timestamp
*
* @return NTP timestamp 64-bit long value as hex string with seconds
* separated by fractional seconds.
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3.java
Sun Jan 18 21:26:41 2015
@@ -178,6 +178,7 @@ public class POP3 extends SocketClient
/***
* Retrieves the additional lines of a multi-line server reply.
+ * @throws IOException on error
***/
public void getAdditionalReply() throws IOException
{
@@ -221,6 +222,7 @@ public class POP3 extends SocketClient
* @param command The POP3 command to send.
* @param args The command arguments.
* @return The server reply code (either POP3Reply.OK, POP3Reply.ERROR or
POP3Reply.OK_INT).
+ * @throws IOException on error
***/
public int sendCommand(String command, String args) throws IOException
{
@@ -253,6 +255,7 @@ public class POP3 extends SocketClient
*
* @param command The POP3 command to send.
* @return The server reply code (either POP3Reply.OK, POP3Reply.ERROR or
POP3Reply.OK_INT).
+ * @throws IOException on error
***/
public int sendCommand(String command) throws IOException
{
@@ -266,6 +269,7 @@ public class POP3 extends SocketClient
* (one of the POP3Command constants).
* @param args The command arguments.
* @return The server reply code (either POP3Reply.OK, POP3Reply.ERROR or
POP3Reply.OK_INT).
+ * @throws IOException on error
***/
public int sendCommand(int command, String args) throws IOException
{
@@ -279,6 +283,7 @@ public class POP3 extends SocketClient
* @param command The POP3 command to send
* (one of the POP3Command constants).
* @return The server reply code (either POP3Reply.OK, POP3Reply.ERROR or
POP3Reply.OK_INT).
+ * @throws IOException on error
***/
public int sendCommand(int command) throws IOException
{
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Command.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Command.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Command.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3Command.java
Sun Jan 18 21:26:41 2015
@@ -79,6 +79,7 @@ public final class POP3Command
/***
* Get the POP3 protocol string command corresponding to a command code.
+ * @param command the command code
*
* @return The POP3 protocol string command corresponding to a command
code.
***/
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java
Sun Jan 18 21:26:41 2015
@@ -58,6 +58,8 @@ public final class POP3MessageInfo
* Creates a POP3MessageInfo instance with <code>number</code> set
* to <code> num </code>, <code> size </code> set to <code> octets </code>,
* and <code>identifier</code> set to null.
+ * @param num the number
+ * @param octets the size
***/
public POP3MessageInfo(int num, int octets)
{
@@ -68,6 +70,8 @@ public final class POP3MessageInfo
* Creates a POP3MessageInfo instance with <code>number</code> set
* to <code> num </code>, <code> size </code> undefined,
* and <code>identifier</code> set to <code>uid</code>.
+ * @param num the number
+ * @param uid the UID
***/
public POP3MessageInfo(int num, String uid)
{
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/Telnet.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/Telnet.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/Telnet.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/Telnet.java
Sun Jan 18 21:26:41 2015
@@ -1091,7 +1091,7 @@ class Telnet extends SocketClient
*
* @param opthand - option handler to be registered.
* @throws InvalidTelnetOptionException - The option code is invalid.
- * @throws IOException
+ * @throws IOException on error
**/
void addOptionHandler(TelnetOptionHandler opthand)
throws InvalidTelnetOptionException, IOException
@@ -1133,7 +1133,7 @@ class Telnet extends SocketClient
*
* @param optcode - Code of the option to be unregistered.
* @throws InvalidTelnetOptionException - The option code is invalid.
- * @throws IOException
+ * @throws IOException on error
**/
void deleteOptionHandler(int optcode)
throws InvalidTelnetOptionException, IOException
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPAckPacket.java
Sun Jan 18 21:26:41 2015
@@ -149,7 +149,11 @@ public final class TFTPAckPacket extends
}
- /*** Sets the block number of the acknowledgement. ***/
+ /***
+ * Sets the block number of the acknowledgement.
+ *
+ * @param blockNumber the number to set
+ ***/
public void setBlockNumber(int blockNumber)
{
_blockNumber = blockNumber;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPClient.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPClient.java
Sun Jan 18 21:26:41 2015
@@ -119,6 +119,7 @@ public class TFTPClient extends TFTP
* @param output The OutputStream to which the file should be written.
* @param host The remote host serving the file.
* @param port The port number of the remote TFTP server.
+ * @return number of bytes read
* @exception IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
***/
@@ -300,6 +301,7 @@ _receivePacket:
* @param output The OutputStream to which the file should be written.
* @param hostname The name of the remote host serving the file.
* @param port The port number of the remote TFTP server.
+ * @return number of bytes read
* @exception IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
* @exception UnknownHostException If the hostname cannot be resolved.
@@ -320,6 +322,7 @@ _receivePacket:
* @param mode The TFTP mode of the transfer (one of the MODE
constants).
* @param output The OutputStream to which the file should be written.
* @param host The remote host serving the file.
+ * @return number of bytes read
* @exception IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
***/
@@ -337,6 +340,7 @@ _receivePacket:
* @param mode The TFTP mode of the transfer (one of the MODE
constants).
* @param output The OutputStream to which the file should be written.
* @param hostname The name of the remote host serving the file.
+ * @return number of bytes read
* @exception IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
* @exception UnknownHostException If the hostname cannot be resolved.
@@ -361,6 +365,7 @@ _receivePacket:
* @param filename The name the remote server should use when creating
* the file on its file system.
* @param mode The TFTP mode of the transfer (one of the MODE
constants).
+ * @param input the input stream containing the data to be sent
* @param host The remote host receiving the file.
* @param port The port number of the remote TFTP server.
* @exception IOException If an I/O error occurs. The nature of the
@@ -557,6 +562,7 @@ _receivePacket:
* @param filename The name the remote server should use when creating
* the file on its file system.
* @param mode The TFTP mode of the transfer (one of the MODE
constants).
+ * @param input the input stream containing the data to be sent
* @param hostname The name of the remote host receiving the file.
* @param port The port number of the remote TFTP server.
* @exception IOException If an I/O error occurs. The nature of the
@@ -577,6 +583,7 @@ _receivePacket:
* @param filename The name the remote server should use when creating
* the file on its file system.
* @param mode The TFTP mode of the transfer (one of the MODE
constants).
+ * @param input the input stream containing the data to be sent
* @param host The name of the remote host receiving the file.
* @exception IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
@@ -595,6 +602,7 @@ _receivePacket:
* @param filename The name the remote server should use when creating
* the file on its file system.
* @param mode The TFTP mode of the transfer (one of the MODE
constants).
+ * @param input the input stream containing the data to be sent
* @param hostname The name of the remote host receiving the file.
* @exception IOException If an I/O error occurs. The nature of the
* error will be reported in the message.
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPDataPacket.java
Sun Jan 18 21:26:41 2015
@@ -198,7 +198,9 @@ public final class TFTPDataPacket extend
return _blockNumber;
}
- /*** Sets the block number of the data packet. ***/
+ /*** Sets the block number of the data packet.
+ * @param blockNumber the number to set
+ ***/
public void setBlockNumber(int blockNumber)
{
_blockNumber = blockNumber;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPPacket.java
Sun Jan 18 21:26:41 2015
@@ -233,13 +233,18 @@ public abstract class TFTPPacket
return _port;
}
- /*** Sets the port where the packet is going to be sent. ***/
+ /***
+ * Sets the port where the packet is going to be sent.
+ * @param port the port to set
+ ***/
public final void setPort(int port)
{
_port = port;
}
- /*** Sets the host address where the packet is going to be sent. ***/
+ /*** Sets the host address where the packet is going to be sent.
+ * @param address the address to set
+ ***/
public final void setAddress(InetAddress address)
{
_address = address;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/time/TimeUDPClient.java?rev=1652855&r1=1652854&r2=1652855&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/time/TimeUDPClient.java
Sun Jan 18 21:26:41 2015
@@ -92,7 +92,11 @@ public final class TimeUDPClient extends
return time;
}
- /*** Same as <code> getTime(host, DEFAULT_PORT); </code> ***/
+ /*** Same as <code> getTime(host, DEFAULT_PORT); </code>
+ * @param host the time server
+ * @return the time returned from the server
+ * @throws IOException on error
+ ***/
public long getTime(InetAddress host) throws IOException
{
return getTime(host, DEFAULT_PORT);
@@ -115,7 +119,11 @@ public final class TimeUDPClient extends
}
- /*** Same as <code> getTime(host, DEFAULT_PORT); </code> ***/
+ /*** Same as <code> getTime(host, DEFAULT_PORT); </code>
+ * @param host the time server
+ * @return the date
+ * @throws IOException on error
+ ***/
public Date getDate(InetAddress host) throws IOException
{
return new Date((getTime(host, DEFAULT_PORT) -
