Author: sebb
Date: Tue Nov 9 11:41:09 2010
New Revision: 1032938
URL: http://svn.apache.org/viewvc?rev=1032938&view=rev
Log:
Add @since markers (from Clirr report)
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/SocketClient.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/FTPFileFilter.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilters.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPHTTPClient.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/FTPReply.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPReply.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threader.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.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/SubnetUtils.java
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=1032938&r1=1032937&r2=1032938&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
Tue Nov 9 11:41:09 2010
@@ -466,6 +466,7 @@ public abstract class SocketClient
* other systems.
* @param keepAlive If true, keepAlive is turned on
* @throws SocketException
+ * @since 2.2
*/
public void setKeepAlive(boolean keepAlive) throws SocketException {
_socket_.setKeepAlive(keepAlive);
@@ -476,6 +477,7 @@ public abstract class SocketClient
*
* @return True if SO_KEEPALIVE is enabled.
* @throws SocketException
+ * @since 2.2
*/
public boolean getKeepAlive() throws SocketException {
return _socket_.getKeepAlive();
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=1032938&r1=1032937&r2=1032938&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
Tue Nov 9 11:41:09 2010
@@ -886,6 +886,7 @@ public class FTP extends SocketClient
* as an IOException or independently as itself.
* @exception IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
+ * @since 2.2
***/
public int eprt(InetAddress host, int port) throws IOException
{
@@ -948,6 +949,7 @@ public class FTP extends SocketClient
* as an IOException or independently as itself.
* @exception IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
+ * @since 2.2
***/
public int epsv() throws IOException
{
@@ -1186,6 +1188,7 @@ public class FTP extends SocketClient
* @return The reply code received by the server
* @throws IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
+ * @since 2.2
*/
public int feat() throws IOException
{
@@ -1256,6 +1259,7 @@ public class FTP extends SocketClient
* as an IOException or independently as itself.
* @exception IOException If an I/O error occurs while either sending the
* command or receiving the server reply.
+ * @since 2.2
* @see <a
href="http://tools.ietf.org/html/draft-somers-ftp-mfxx-04";>http://tools.ietf.org/html/draft-somers-ftp-mfxx-04</a>
**/
public int mfmt(String pathname, String timeval) 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=1032938&r1=1032937&r2=1032938&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
Tue Nov 9 11:41:09 2010
@@ -1078,6 +1078,7 @@ implements Configurable
* <p>
* @param minPort The lowest available port (inclusive).
* @param maxPort The highest available port (inclusive).
+ * @since 2.2
***/
public void setActivePortRange(int minPort, int maxPort)
{
@@ -1091,6 +1092,7 @@ implements Configurable
* <p>
* @param ipAddress The external IP address of this machine.
* @throws UnknownHostException
+ * @since 2.2
***/
public void setActiveExternalIPAddress(String ipAddress) throws
UnknownHostException
{
@@ -1792,6 +1794,7 @@ implements Configurable
* @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.
* @throws IOException
+ * @since 2.2
*/
public boolean features() throws IOException {
return FTPReply.isPositiveCompletion(feat());
@@ -2026,7 +2029,8 @@ 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.
- * @deprecated Use {...@link #getSystemType()} - which does not return
null
+ * @deprecated Use {...@link #getSystemType()} - which does not return
null.
+ * Will be deleted in version 3.0
***/
@Deprecated
public String getSystemName() throws IOException
@@ -2058,6 +2062,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 2.2
***/
public String getSystemType() throws IOException
{
@@ -2324,6 +2329,7 @@ implements Configurable
* @param filter the filter, non-null
* @return the list of FTPFile entries.
* @throws IOException
+ * @since 2.2
*/
public FTPFile[] listFiles(String pathname, FTPFileFilter filter)
throws IOException
@@ -2648,6 +2654,7 @@ implements Configurable
* @param timeval The timestamp to set to, in <code>YYYYMMDDhhmmss</code>
format.
* @return true if successfully set, false if not
* @throws IOException if an I/O error occurs.
+ * @since 2.2
* @see <a
href="http://tools.ietf.org/html/draft-somers-ftp-mfxx-04";>http://tools.ietf.org/html/draft-somers-ftp-mfxx-04</a>
*/
public boolean setModificationTime(String pathname, String timeval) throws
IOException {
@@ -2711,6 +2718,7 @@ implements Configurable
* Whether should attempt to use EPSV with IPv4.
* Default (if not set) is <code>false</code>
* @return true if should attempt EPS
+ * @since 2.2
*/
public boolean isUseEPSVwithIPv4() {
return __useEPSVwithIPv4;
@@ -2729,6 +2737,7 @@ implements Configurable
* while EPSV would make the client succeed by taking just the port.
*
* @param selected value to set.
+ * @since 2.2
*/
public void setUseEPSVwithIPv4(boolean selected) {
this.__useEPSVwithIPv4 = selected;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilter.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilter.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilter.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilter.java
Tue Nov 9 11:41:09 2010
@@ -20,6 +20,7 @@ package org.apache.commons.net.ftp;
/**
* Perform filtering on FTPFile entries.
+ * @since 2.2
*/
public interface FTPFileFilter {
/**
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilters.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilters.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilters.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPFileFilters.java
Tue Nov 9 11:41:09 2010
@@ -20,6 +20,7 @@ package org.apache.commons.net.ftp;
/**
* Implements some simple FTPFileFilter classes.
+ * @since 2.2
*/
public class FTPFileFilters {
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPHTTPClient.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPHTTPClient.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPHTTPClient.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPHTTPClient.java
Tue Nov 9 11:41:09 2010
@@ -34,7 +34,7 @@ import org.apache.commons.net.util.Base6
* Experimental attempt at FTP client that tunnels over an HTTP proxy
connection.
*
* @author rory
- *
+ * @since 2.2
*/
public class FTPHTTPClient extends FTPClient {
private final String proxyHost;
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=1032938&r1=1032937&r2=1032938&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
Tue Nov 9 11:41:09 2010
@@ -266,7 +266,7 @@ public class FTPListParseEngine {
* check each entry for null before referencing it, or use the
* a filter such as {...@link FTPFileFilters#NON_NULL} which does not
* allow null entries.
- *
+ * @since 2.2
* @exception IOException
*/
public FTPFile[] getFiles(FTPFileFilter filter)
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPReply.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPReply.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPReply.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPReply.java
Tue Nov 9 11:41:09 2010
@@ -49,6 +49,7 @@ public final class FTPReply
public static final int CODE_225 = 225;
public static final int CODE_226 = 226;
public static final int CODE_227 = 227;
+ /** @since 2.2 */
public static final int CODE_229 = 229;
public static final int CODE_230 = 230;
public static final int CODE_250 = 250;
@@ -91,6 +92,7 @@ public final class FTPReply
public static final int DATA_CONNECTION_OPEN = CODE_225;
public static final int CLOSING_DATA_CONNECTION = CODE_226;
public static final int ENTERING_PASSIVE_MODE = CODE_227;
+ /** @since 2.2 */
public static final int ENTERING_EPSV_MODE = CODE_229;
public static final int USER_LOGGED_IN = CODE_230;
public static final int FILE_ACTION_OK = CODE_250;
@@ -161,6 +163,7 @@ public final class FTPReply
// IPv6 error codes
// Note this is also used as an FTPS error code reply
+ /** @since 2.2 */
public static final int EXTENDED_PORT_FAILURE = CODE_522;
// Cannot be instantiated
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
Tue Nov 9 11:41:09 2010
@@ -27,6 +27,7 @@ import javax.net.ssl.SSLServerSocket;
/**
* Server socket factory for FTPS connections.
+ * @since 2.2
*/
public class FTPSServerSocketFactory extends ServerSocketFactory {
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/FTPSSocketFactory.java
Tue Nov 9 11:41:09 2010
@@ -61,25 +61,26 @@ public class FTPSSocketFactory extends S
return this.context.getSocketFactory().createSocket(address, port,
localAddress, localPort);
}
- /** @deprecated use {...@link
FTPSServerSocketFactory#createServerSocket(int) instead} */
+ /** @deprecated (2.2) use {...@link
FTPSServerSocketFactory#createServerSocket(int) instead} */
@Deprecated
public ServerSocket createServerSocket(int port) throws IOException {
return
this.init(this.context.getServerSocketFactory().createServerSocket(port));
}
- /** @deprecated use {...@link
FTPSServerSocketFactory#createServerSocket(int, int) instead} */
+ /** @deprecated (2.2) use {...@link
FTPSServerSocketFactory#createServerSocket(int, int) instead} */
@Deprecated
public ServerSocket createServerSocket(int port, int backlog) throws
IOException {
return
this.init(this.context.getServerSocketFactory().createServerSocket(port,
backlog));
}
- /** @deprecated use {...@link
FTPSServerSocketFactory#createServerSocket(int, int, InetAddress) instead} */
+ /** @deprecated (2.2) use {...@link
FTPSServerSocketFactory#createServerSocket(int, int, InetAddress) instead} */
@Deprecated
public ServerSocket createServerSocket(int port, int backlog, InetAddress
ifAddress) throws IOException {
return
this.init(this.context.getServerSocketFactory().createServerSocket(port,
backlog, ifAddress));
}
- /** @deprecated use {...@link FTPSServerSocketFactory#init(ServerSocket)}
*/
+ /** @deprecated (2.2) use {...@link
FTPSServerSocketFactory#init(ServerSocket)} */
+ @SuppressWarnings("unused")
@Deprecated
public ServerSocket init(ServerSocket socket) throws IOException {
((SSLServerSocket) socket).setUseClientMode(true);
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/ftp/parser/VMSFTPEntryParser.java
Tue Nov 9 11:41:09 2010
@@ -113,7 +113,7 @@ public class VMSFTPEntryParser extends C
* if the list could not be obtained or if there are no files in
* the directory.
* @exception IOException If an I/O error occurs reading the listStream.
- * @deprecated No other FTPFileEntryParser implementations have this
method.
+ * @deprecated (2.2) No other FTPFileEntryParser implementations have this
method.
* Not currently used by NET code. To be removed in 3.0
***/
@Deprecated
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPReply.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPReply.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPReply.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPReply.java
Tue Nov 9 11:41:09 2010
@@ -67,6 +67,7 @@ public final class NNTPReply
public static final int CODE_437 = 437;
public static final int CODE_440 = 440;
public static final int CODE_441 = 441;
+ /** @since 2.2 */
public static final int CODE_480 = 480;
public static final int CODE_482 = 482;
public static final int CODE_500 = 500;
@@ -107,6 +108,7 @@ public final class NNTPReply
public static final int ARTICLE_REJECTED = CODE_437;
public static final int POSTING_NOT_ALLOWED = CODE_440;
public static final int POSTING_FAILED = CODE_441;
+ /** @since 2.2 - corrected value to 480 */
public static final int AUTHENTICATION_REQUIRED = CODE_480;
public static final int AUTHENTICATION_REJECTED = CODE_482;
public static final int COMMAND_NOT_RECOGNIZED = CODE_500;
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threader.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threader.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threader.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/Threader.java
Tue Nov 9 11:41:09 2010
@@ -42,7 +42,7 @@ public class Threader {
* the Threader constructs a connected 'graph' of messages
* @param messages array of messages to thread
* @return null if messages == null or root.child == null
- * @deprecated prefer {...@link #thread(List)}
+ * @deprecated (2.2) prefer {...@link #thread(List)}
*/
@Deprecated
public Threadable thread(Threadable[] messages) {
@@ -54,6 +54,7 @@ public class Threader {
* the Threader constructs a connected 'graph' of messages
* @param messages list of messages to thread
* @return null if messages == null or root.child == null
+ * @since 2.2
*/
public Threadable thread(List<? extends Threadable> messages) {
if (messages == null)
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java?rev=1032938&r1=1032937&r2=1032938&view=diff
==============================================================================
---
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
(original)
+++
commons/proper/net/trunk/src/main/java/org/apache/commons/net/telnet/TelnetNotificationHandler.java
Tue Nov 9 11:41:09 2010
@@ -54,6 +54,7 @@ public interface TelnetNotificationHandl
/***
* The remote party sent a COMMAND.
+ * @since 2.2
***/
public static final int RECEIVED_COMMAND = 5;
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=1032938&r1=1032937&r2=1032938&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
Tue Nov 9 11:41:09 2010
@@ -45,7 +45,7 @@ import java.math.BigInteger;
*
* @see <a href="http://www.ietf.org/rfc/rfc2045.txt";>RFC 2045</a>
* @author Apache Software Foundation
- * @since 1.0
+ * @since 2.2
* @version $Id$
*/
public class Base64 {
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=1032938&r1=1032937&r2=1032938&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
Tue Nov 9 11:41:09 2010
@@ -67,6 +67,7 @@ public class SubnetUtils {
/**
* Returns <code>true</code> if the return value of {...@link
SubnetInfo#getAddressCount()}
* includes the network address and broadcast addresses.
+ * @since 2.2
*/
public boolean isInclusiveHostCount() {
return inclusiveHostCount;
@@ -76,6 +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
+ * @since 2.2
*/
public void setInclusiveHostCount(boolean inclusiveHostCount) {
this.inclusiveHostCount = inclusiveHostCount;
@@ -136,6 +138,10 @@ public class SubnetUtils {
return addresses;
}
+ /**
+ * {...@inheritdoc}
+ * @since 2.2
+ */
@Override
public String toString() {
final StringBuilder buf = new StringBuilder();
