Author: sebb
Date: Fri Feb 10 23:59:31 2017
New Revision: 1782545
URL: http://svn.apache.org/viewvc?rev=1782545&view=rev
Log:
@since markers
Modified:
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/pop3/POP3MessageInfo.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTP.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/TFTPDataPacket.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.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/tftp/TFTPReadRequestPacket.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPWriteRequestPacket.java
commons/proper/net/trunk/src/test/java/org/apache/commons/net/tftp/TFTPServerMain.java
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=1782545&r1=1782544&r2=1782545&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
Fri Feb 10 23:59:31 2017
@@ -3780,7 +3780,7 @@ implements Configurable
* The default is true, i.e. site-local replies are replaced.
* @param enabled true to enable replacing internal IP's in passive
* mode.
- * @deprecated use {@link
#setPassiveNatWorkaroundStrategy(HostnameResolver)} instead
+ * @deprecated (3.6) use {@link
#setPassiveNatWorkaroundStrategy(HostnameResolver)} instead
*/
@Deprecated
public void setPassiveNatWorkaround(boolean enabled) {
@@ -3818,6 +3818,7 @@ implements Configurable
/**
* Default strategy for passive NAT workaround (site-local
* replies are replaced.)
+ * @since 3.6
*/
public static class NatServerResolverImpl implements HostnameResolver {
private FTPClient client;
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=1782545&r1=1782544&r2=1782545&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
Fri Feb 10 23:59:31 2017
@@ -351,6 +351,11 @@ public class FTPClientConfig
this.shortMonthNames = config.shortMonthNames;
}
+ /**
+ * Copy constructor
+ * @param config source
+ * @since 3.6
+ */
public FTPClientConfig(FTPClientConfig config) {
this.serverSystemKey = config.serverSystemKey;
this.defaultDateFormatStr = config.defaultDateFormatStr;
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=1782545&r1=1782544&r2=1782545&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
Fri Feb 10 23:59:31 2017
@@ -84,6 +84,9 @@ public final class POP3MessageInfo
this.identifier = uid;
}
+ /**
+ * @since 3.6
+ */
@Override
public String toString() {
return "Number: " + number + ". Size: " + size + ". Id: " + identifier;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTP.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTP.java?rev=1782545&r1=1782544&r2=1782545&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTP.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTP.java
Fri Feb 10 23:59:31 2017
@@ -303,10 +303,16 @@ public class TFTP extends DatagramSocket
return newTFTPPacket;
}
- // Override this to trace the packet flow
+ /**
+ * Trace facility; this implementation does nothing.
+ * <p>
+ * Override it to trace the data, for example:<br>
+ * {@code System.out.println(direction + " " + packet.toString());}
+ * @param direction ">" or "<"
+ * @param packet the packet to be sent or that has been received
+ * @since 3.6
+ */
protected void trace(String direction, TFTPPacket packet) {
-// Simple implementation:
-// System.out.println(direction + " " + packet.toString());
}
}
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=1782545&r1=1782544&r2=1782545&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
Fri Feb 10 23:59:31 2017
@@ -159,7 +159,10 @@ public final class TFTPAckPacket extends
_blockNumber = blockNumber;
}
- // for debugging
+ /**
+ * For debugging
+ * @since 3.6
+ */
@Override
public String toString() {
return super.toString() + " ACK " + _blockNumber;
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=1782545&r1=1782544&r2=1782545&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
Fri Feb 10 23:59:31 2017
@@ -258,7 +258,10 @@ public final class TFTPDataPacket extend
return _data;
}
- // for debugging
+ /**
+ * For debugging
+ * @since 3.6
+ */
@Override
public String toString() {
return super.toString() + " DATA " + _blockNumber + " " + _length;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java?rev=1782545&r1=1782544&r2=1782545&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPErrorPacket.java
Fri Feb 10 23:59:31 2017
@@ -225,7 +225,10 @@ public final class TFTPErrorPacket exten
return _message;
}
- // for debugging
+ /**
+ * For debugging
+ * @since 3.6
+ */
@Override
public String toString() {
return super.toString() + " ERR " + _error + " " + _message;
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=1782545&r1=1782544&r2=1782545&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
Fri Feb 10 23:59:31 2017
@@ -250,7 +250,10 @@ public abstract class TFTPPacket
_address = address;
}
- // for debugging
+ /**
+ * For debugging
+ * @since 3.6
+ */
@Override
public String toString() {
return _address + " " + _port + " " + _type;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPReadRequestPacket.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPReadRequestPacket.java?rev=1782545&r1=1782544&r2=1782545&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPReadRequestPacket.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPReadRequestPacket.java
Fri Feb 10 23:59:31 2017
@@ -76,7 +76,10 @@ public final class TFTPReadRequestPacket
super(TFTPPacket.READ_REQUEST, datagram);
}
- // for debugging
+ /**
+ * For debugging
+ * @since 3.6
+ */
@Override
public String toString() {
return super.toString() + " RRQ " + getFilename() + " " +
TFTP.getModeName(getMode());
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPWriteRequestPacket.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPWriteRequestPacket.java?rev=1782545&r1=1782544&r2=1782545&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPWriteRequestPacket.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/tftp/TFTPWriteRequestPacket.java
Fri Feb 10 23:59:31 2017
@@ -76,7 +76,10 @@ public final class TFTPWriteRequestPacke
super(TFTPPacket.WRITE_REQUEST, datagram);
}
- // for debugging
+ /**
+ * For debugging
+ * @since 3.6
+ */
@Override
public String toString() {
return super.toString() + " WRQ " + getFilename() + " " +
TFTP.getModeName(getMode());
Modified:
commons/proper/net/trunk/src/test/java/org/apache/commons/net/tftp/TFTPServerMain.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/test/java/org/apache/commons/net/tftp/TFTPServerMain.java?rev=1782545&r1=1782544&r2=1782545&view=diff
==============================================================================
---
commons/proper/net/trunk/src/test/java/org/apache/commons/net/tftp/TFTPServerMain.java
(original)
+++
commons/proper/net/trunk/src/test/java/org/apache/commons/net/tftp/TFTPServerMain.java
Fri Feb 10 23:59:31 2017
@@ -25,7 +25,8 @@ import java.util.Random;
/**
* Main class for TFTPServer.
- * This allows CLI use of the server.
+ * This allows CLI use of the server.
+ * @since 3.6
*/
public class TFTPServerMain {
