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 20:50:52 UTC
svn commit: r1587077 - in
/commons/proper/net/trunk/src/main/java/org/apache/commons/net:
finger/FingerClient.java nntp/NNTPClient.java
nntp/NNTPConnectionClosedException.java nntp/SimpleNNTPHeader.java
Author: sebb
Date: Sun Apr 13 18:50:52 2014
New Revision: 1587077
URL: http://svn.apache.org/r1587077
Log:
Java 8 Javadoc fixes
Modified:
commons/proper/net/trunk/src/main/java/org/apache/commons/net/finger/FingerClient.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/NNTPConnectionClosedException.java
commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/finger/FingerClient.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/finger/FingerClient.java?rev=1587077&r1=1587076&r2=1587077&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/finger/FingerClient.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/finger/FingerClient.java Sun Apr 13 18:50:52 2014
@@ -47,8 +47,7 @@ import org.apache.commons.net.util.Chars
* return;
* }
* </pre>
- * <p>
- * <p>
+ *
***/
public class FingerClient extends SocketClient
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=1587077&r1=1587076&r2=1587077&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 18:50:52 2014
@@ -77,8 +77,7 @@ import org.apache.commons.net.io.Util;
* 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 NNTP
@@ -847,7 +846,9 @@ public class NNTPClient extends NNTP
return true;
}
- /**** Same as <code> selectArticle(articleId, (ArticleInfo) null) </code> ***/
+ /**
+ * Same as <code> selectArticle(articleId, (ArticleInfo) null) </code>
+ */
public boolean selectArticle(String articleId) throws IOException
{
return selectArticle(articleId, (ArticleInfo) null);
@@ -1715,86 +1716,111 @@ public class NNTPClient extends NNTP
}
/**
+ * @param articleId The unique article identifier of the article to retrieve
+ * @param pointer A parameter through which to return the article's number and unique id
* @deprecated 3.0 use {@link #retrieveArticle(String, ArticleInfo)} instead
* @return A DotTerminatedMessageReader instance from which the article can be read.
* null if the article does not exist.
+ * @throws IOException on error
*/
@Deprecated
- public Reader retrieveArticle(String a, ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
- Reader rdr = retrieveArticle(a, ai);
- __ai2ap(ai, ap);
+ public Reader retrieveArticle(String articleId, ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
+ Reader rdr = retrieveArticle(articleId, ai);
+ __ai2ap(ai, pointer);
return rdr;
}
/**
+ * @param articleId The unique article identifier of the article to retrieve
+ * @param pointer A parameter through which to return the article's number and unique id
* @return A DotTerminatedMessageReader instance from which the article
* body can be read. null if the article does not exist.
+ * @throws IOException on error
* @deprecated 3.0 use {@link #retrieveArticleBody(String, ArticleInfo)} instead
*/
@Deprecated
- public Reader retrieveArticleBody(String a, ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
- Reader rdr = retrieveArticleBody(a, ai);
- __ai2ap(ai, ap);
+ public Reader retrieveArticleBody(String articleId, ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
+ Reader rdr = retrieveArticleBody(articleId, ai);
+ __ai2ap(ai, pointer);
return rdr;
}
/**
+ * @param articleId The unique article identifier of the article to retrieve
+ * @param pointer A parameter through which to return the article's number and unique id
+ * @return A DotTerminatedMessageReader instance from which the article
+ * body can be read. null if the article does not exist.
+ * @throws IOException on error
* @deprecated 3.0 use {@link #retrieveArticleHeader(String, ArticleInfo)} instead
*/
@Deprecated
- public Reader retrieveArticleHeader(String a, ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
- Reader rdr = retrieveArticleHeader(a, ai);
- __ai2ap(ai, ap);
+ public Reader retrieveArticleHeader(String articleId, ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
+ Reader rdr = retrieveArticleHeader(articleId, ai);
+ __ai2ap(ai, pointer);
return rdr;
}
/**
+ * @param articleId The unique article identifier of the article to retrieve
+ * @param pointer A parameter through which to return the article's number and unique id
+ * @return A DotTerminatedMessageReader instance from which the article
+ * body can be read. null if the article does not exist.
+ * @throws IOException on error
* @deprecated 3.0 use {@link #selectArticle(String, ArticleInfo)} instead
*/
@Deprecated
- public boolean selectArticle(String a, ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
- boolean b = selectArticle(a, ai);
- __ai2ap(ai, ap);
+ public boolean selectArticle(String articleId, ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
+ boolean b = selectArticle(articleId, ai);
+ __ai2ap(ai, pointer);
return b;
}
/**
+ * @param pointer A parameter through which to return the article's number and unique id
+ * @return True if successful, false if not.
+ * @throws IOException on error
* @deprecated 3.0 use {@link #selectArticle(ArticleInfo)} instead
*/
@Deprecated
- public boolean selectArticle(ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
+ public boolean selectArticle(ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
boolean b = selectArticle(ai);
- __ai2ap(ai, ap);
+ __ai2ap(ai, pointer);
return b;
}
/**
+ * @param pointer A parameter through which to return the article's number and unique id
+ * @return True if successful, false if not.
+ * @throws IOException on error
* @deprecated 3.0 use {@link #selectNextArticle(ArticleInfo)} instead
*/
@Deprecated
- public boolean selectNextArticle(ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
+ public boolean selectNextArticle(ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
boolean b = selectNextArticle(ai);
- __ai2ap(ai, ap);
+ __ai2ap(ai, pointer);
return b;
}
/**
+ * @param pointer A parameter through which to return the article's number and unique id
+ * @return True if successful, false if not.
+ * @throws IOException on error
* @deprecated 3.0 use {@link #selectPreviousArticle(ArticleInfo)} instead
*/
@Deprecated
- public boolean selectPreviousArticle(ArticlePointer ap) throws IOException {
- ArticleInfo ai = __ap2ai(ap);
+ public boolean selectPreviousArticle(ArticlePointer pointer) throws IOException {
+ ArticleInfo ai = __ap2ai(pointer);
boolean b = selectPreviousArticle(ai);
- __ai2ap(ai, ap);
+ __ai2ap(ai, pointer);
return b;
}
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPConnectionClosedException.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPConnectionClosedException.java?rev=1587077&r1=1587076&r2=1587077&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPConnectionClosedException.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/NNTPConnectionClosedException.java Sun Apr 13 18:50:52 2014
@@ -27,8 +27,7 @@ import java.io.IOException;
* failed NNTP command. This exception is derived from IOException and
* therefore may be caught either as an IOException or specifically as an
* NNTPConnectionClosedException.
- * <p>
- * <p>
+ *
* @see NNTP
* @see NNTPClient
***/
Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java?rev=1587077&r1=1587076&r2=1587077&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/nntp/SimpleNNTPHeader.java Sun Apr 13 18:50:52 2014
@@ -40,8 +40,7 @@ package org.apache.commons.net.nntp;
* if(!client.completePendingCommand()) // failure
* return false;
* </pre>
- * <p>
- * <p>
+ *
* @see NNTPClient
***/