Author: sebb
Date: Sun Jan 18 22:23:20 2015
New Revision: 1652863
URL: http://svn.apache.org/r1652863
Log:
Javadoc @since
Modified:
commons/proper/net/trunk/src/main/java/examples/Main.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/FTPClientConfig.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.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/IMAPClient.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/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/util/SubnetUtils.java
Modified: commons/proper/net/trunk/src/main/java/examples/Main.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/examples/Main.java?rev=1652863&r1=1652862&r2=1652863&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/examples/Main.java (original)
+++ commons/proper/net/trunk/src/main/java/examples/Main.java Sun Jan 18
22:23:20 2015
@@ -26,6 +26,9 @@ import java.util.Collections;
import java.util.List;
import java.util.Properties;
+/**
+ * Helper application for example classes.
+ */
public class Main {
/**
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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -382,6 +382,14 @@ public class FTP extends SocketClient
}
+ /**
+ * Initiates control connections and gets initial reply.
+ * Initializes {@link #_controlInput_} and {@link #_controlOutput_}.
+ *
+ * @param socketIsReader the reader to reuse (if non-null)
+ * @throws IOException on error
+ * @since 3.4
+ */
protected void _connectAction_(Reader socketIsReader) throws IOException {
super._connectAction_(); // sets up _input_ and _output_
if(socketIsReader == null) {
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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -954,6 +954,11 @@ implements Configurable
}
+ /**
+ * @param socketIsReader the reader to reuse (if non-null)
+ * @throws IOException on error
+ * @since 3.4
+ */
@Override
protected void _connectAction_(Reader socketIsReader) throws IOException
{
@@ -1213,6 +1218,7 @@ implements Configurable
* as an IOException or independently as itself.
* @exception IOException If an I/O error occurs while either sending a
* command to the server or receiving a reply from the server.
+ * @since 3.4 (made public)
*/
public boolean reinitialize() throws IOException
{
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java?rev=1652863&r1=1652862&r2=1652863&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPClientConfig.java
Sun Jan 18 22:23:20 2015
@@ -149,6 +149,7 @@ public class FTPClientConfig
* trimmed from file names. This is to maintain backwards compatibility
with
* the original behaviour of the parser which ignored multiple spaces
between the date
* and the start of the file name.
+ * @since 3.4
*/
public static final String SYST_UNIX_TRIM_LEADING = "UNIX_LTRIM";
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java?rev=1652863&r1=1652862&r2=1652863&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/UnixFTPEntryParser.java
Sun Jan 18 22:23:20 2015
@@ -172,7 +172,7 @@ public class UnixFTPEntryParser extends
* Thrown if the regular expression is unparseable. Should not be seen
* under normal conditions. It it is seen, this is a sign that
* <code>REGEX</code> is not a valid regular expression.
- * @since 1.4
+ * @since 3.4
*/
public UnixFTPEntryParser(FTPClientConfig config, boolean
trimLeadingSpaces)
{
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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -98,6 +98,7 @@ public class IMAP extends SocketClient
* This should not be a problem for listeners that just log the input.
* </p>
* @see #setChunkListener(IMAPChunkListener)
+ * @since 3.4
*/
public static final IMAPChunkListener TRUE_CHUNK_LISTENER = new
IMAPChunkListener(){
public boolean chunkReceived(IMAP imap) {
@@ -195,6 +196,7 @@ public class IMAP extends SocketClient
* @param replyCode passed to the listeners
* @param ignored the string is only created if there are listeners
defined.
* @see #getReplyString()
+ * @since 3.4
*/
@Override
protected void fireReplyReceived(int replyCode, String ignored) {
@@ -435,6 +437,7 @@ public class IMAP extends SocketClient
* {@link IMAPReply#PARTIAL} to indicate that the final reply code is not
yet known.
* @param listener the class to use, or {@code null} to disable
* @see #TRUE_CHUNK_LISTENER
+ * @since 3.4
*/
public void setChunkListener(IMAPChunkListener listener) {
__chunkListener = listener;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPClient.java?rev=1652863&r1=1652862&r2=1652863&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPClient.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/imap/IMAPClient.java
Sun Jan 18 22:23:20 2015
@@ -243,6 +243,7 @@ public class IMAPClient extends IMAP
* @param message The message to append.
* @return {@code true} if the command was successful,{@code false} if not.
* @exception IOException If a network I/O error occurs.
+ * @since 3.4
*/
public boolean append(String mailboxName, String flags, String datetime,
String message) 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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -45,6 +45,7 @@ public final class IMAPReply
* The reply code indicating a partial response.
* This is used when a chunk listener is registered and the listener
* requests that the reply lines are cleared on return.
+ * @since 3.4
*/
public static final int PARTIAL = 3;
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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -163,6 +163,7 @@ public class NtpV3Impl implements NtpV3P
/***
* Set precision as defined in RFC-1305.
* @param precision the precision to set
+ * @since 3.4
*/
public void setPrecision(int precision)
{
@@ -232,6 +233,7 @@ public class NtpV3Impl implements NtpV3P
* Set root delay as defined in RFC-1305.
*
* @param delay root delay
+ * @since 3.4
*/
// @Override
public void setRootDelay(int delay)
@@ -268,6 +270,7 @@ public class NtpV3Impl implements NtpV3P
* Set root dispersion as defined in RFC-1305.
*
* @param dispersion root dispersion
+ * @since 3.4
*/
// @Override
public void setRootDispersion(int dispersion)
@@ -616,6 +619,7 @@ public class NtpV3Impl implements NtpV3P
* @param obj the object to compare with.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
+ * @since 3.4
*/
@Override
public boolean equals(Object obj)
@@ -635,6 +639,7 @@ public class NtpV3Impl implements NtpV3P
* OR of the values of this object stored as a byte array.
*
* @return a hash code value for this object.
+ * @since 3.4
*/
@Override
public int hashCode()
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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -124,6 +124,7 @@ public interface NtpV3Packet
/**
* Set precision as defined in RFC-1305
* @param precision Precision
+ * @since 3.4
*/
void setPrecision(int precision);
@@ -135,6 +136,7 @@ public interface NtpV3Packet
/**
* Set root delay as defined in RFC-1305
* @param delay the delay to set
+ * @since 3.4
*/
void setRootDelay(int delay);
@@ -151,6 +153,7 @@ public interface NtpV3Packet
/**
*
* @param dispersion the value to set
+ * @since 3.4
*/
void setRootDispersion(int dispersion);
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=1652863&r1=1652862&r2=1652863&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 22:23:20 2015
@@ -288,6 +288,7 @@ public class TimeInfo {
/**
* Get host address from message datagram if available
* @return host address of available otherwise null
+ * @since 3.4
*/
public InetAddress getAddress() {
DatagramPacket pkt = _message.getDatagramPacket();
@@ -313,6 +314,7 @@ public class TimeInfo {
* @param obj the object to compare with.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
+ * @since 3.4
*/
@Override
public boolean equals(Object obj)
@@ -332,6 +334,7 @@ public class TimeInfo {
* OR of the return time and the message hash code.
*
* @return a hash code value for this object.
+ * @since 3.4
*/
@Override
public int hashCode()
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=1652863&r1=1652862&r2=1652863&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 Jan 18 22:23:20 2015
@@ -126,6 +126,12 @@ public class SubnetUtils {
return isInRange(toInteger(address));
}
+ /**
+ *
+ * @param address the address to check
+ * @return true if it is in range
+ * @since 3.4 (made public)
+ */
public boolean isInRange(int address) {
long addLong = address & UNSIGNED_INT_MASK;
long lowLong = low() & UNSIGNED_INT_MASK;
@@ -174,7 +180,7 @@ public class SubnetUtils {
* Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.
* @return the count of addresses, may be zero.
* @throws RuntimeException if the correct count is greater than
{@code Integer.MAX_VALUE}
- * @deprecated use {@link #getAddressCountLong()} instead
+ * @deprecated (3.4) use {@link #getAddressCountLong()} instead
*/
@Deprecated
public int getAddressCount() {
@@ -190,6 +196,7 @@ public class SubnetUtils {
* Get the count of available addresses.
* Will be zero for CIDR/31 and CIDR/32 if the inclusive flag is false.
* @return the count of addresses, may be zero.
+ * @since 3.4
*/
public long getAddressCountLong() {
long b = broadcastLong();
