You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by se...@apache.org on 2014/08/29 02:06:54 UTC
svn commit: r1621232 - in /httpcomponents/httpcore/trunk:
httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/
httpcore-nio/src/main/java/org/apache/http/nio/
httpcore-nio/src/main/java/org/apache/http/nio/reactor/
httpcore/src/main/java...
Author: sebb
Date: Fri Aug 29 00:06:53 2014
New Revision: 1621232
URL: http://svn.apache.org/r1621232
Log:
Javadoc8 fixes
Modified:
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/HttpRequestExecutionHandler.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestExecutionHandler.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestHandler.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentEncoder.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/IOControl.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/SessionRequest.java
httpcomponents/httpcore/trunk/httpcore/src/main/java-deprecated/org/apache/http/impl/io/AbstractSessionOutputBuffer.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/HttpEntity.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/entity/ContentType.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/ContentLengthInputStream.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SessionOutputBufferImpl.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/util/LangUtils.java
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/HttpRequestExecutionHandler.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/HttpRequestExecutionHandler.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/HttpRequestExecutionHandler.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/HttpRequestExecutionHandler.java Fri Aug 29 00:06:53 2014
@@ -65,12 +65,12 @@ public interface HttpRequestExecutionHan
/**
* Triggered when the underlying connection is ready to send a new
* HTTP request to the target host. This method may return
- * <code>null</null> if the client is not yet ready to send a
+ * <code>null</code> if the client is not yet ready to send a
* request. In this case the connection will remain open and
* can be activated at a later point.
*
* @param context the actual HTTP context
- * @return an HTTP request to be sent or <code>null</null> if no
+ * @return an HTTP request to be sent or <code>null</code> if no
* request needs to be sent
*/
HttpRequest submitRequest(HttpContext context);
@@ -80,6 +80,7 @@ public interface HttpRequestExecutionHan
*
* @param response the HTTP response to be processed
* @param context the actual HTTP context
+ * @throws IOException if a problem is encountered
*/
void handleResponse(HttpResponse response, HttpContext context)
throws IOException;
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestExecutionHandler.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestExecutionHandler.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestExecutionHandler.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestExecutionHandler.java Fri Aug 29 00:06:53 2014
@@ -70,7 +70,7 @@ public interface NHttpRequestExecutionHa
/**
* Triggered when the underlying connection is ready to send a new
* HTTP request to the target host. This method may return
- * <code>null</null> if the client is not yet ready to send a
+ * <code>null</code> if the client is not yet ready to send a
* request. In this case the connection will remain open and
* can be activated at a later point.
* <p>
@@ -78,7 +78,7 @@ public interface NHttpRequestExecutionHa
* instance of {@link org.apache.http.nio.entity.ProducingNHttpEntity}.
*
* @param context the actual HTTP context
- * @return an HTTP request to be sent or <code>null</null> if no
+ * @return an HTTP request to be sent or <code>null</code> if no
* request needs to be sent
*/
HttpRequest submitRequest(HttpContext context);
@@ -91,7 +91,7 @@ public interface NHttpRequestExecutionHa
* <p>
* After the entity is fully consumed,
* {@link NHttpRequestExecutionHandler#handleResponse(HttpResponse, HttpContext)}
- * is called to notify a full response & entity are ready to be processed.
+ * is called to notify a full response & entity are ready to be processed.
*
* @param response
* The response containing the existing entity.
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestHandler.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestHandler.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestHandler.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java-deprecated/org/apache/http/nio/protocol/NHttpRequestHandler.java Fri Aug 29 00:06:53 2014
@@ -60,7 +60,7 @@ public interface NHttpRequestHandler {
* <p>
* After the entity is fully consumed,
* {@link #handle(HttpRequest, HttpResponse, NHttpResponseTrigger, HttpContext)}
- * is called to notify a full request & entity are ready to be processed.
+ * is called to notify a full request & entity are ready to be processed.
*
* @param request the entity enclosing request.
* @param context the execution context.
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java Fri Aug 29 00:06:53 2014
@@ -53,7 +53,7 @@ public interface FileContentDecoder exte
* @param count
* The maximum number of bytes to be transferred; must be
* non-negative
- * @throws IOException, if some I/O error occurs.
+ * @throws IOException if some I/O error occurs.
* @return The number of bytes, possibly zero,
* that were actually transferred
*/
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentEncoder.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentEncoder.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentEncoder.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/FileContentEncoder.java Fri Aug 29 00:06:53 2014
@@ -48,7 +48,7 @@ public interface FileContentEncoder exte
* @param count
* The maximum number of bytes to be transferred; must be
* non-negative
- *@throws IOException, if some I/O error occurs.
+ * @throws IOException if some I/O error occurs.
* @return The number of bytes, possibly zero,
* that were actually transferred
*/
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/IOControl.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/IOControl.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/IOControl.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/IOControl.java Fri Aug 29 00:06:53 2014
@@ -68,7 +68,7 @@ public interface IOControl {
/**
* Shuts down the underlying channel.
*
- * @throws IOException
+ * @throws IOException in an error occurs
*/
void shutdown() throws IOException;
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/SessionRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/SessionRequest.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/SessionRequest.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/reactor/SessionRequest.java Fri Aug 29 00:06:53 2014
@@ -68,8 +68,8 @@ public interface SessionRequest {
* Determines whether the request has been completed (either successfully
* or unsuccessfully).
*
- * @return <code>true</true> if the request has been completed,
- * <code>false</true> if still pending.
+ * @return <code>true</code> if the request has been completed,
+ * <code>false</code> if still pending.
*/
boolean isCompleted();
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java-deprecated/org/apache/http/impl/io/AbstractSessionOutputBuffer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java-deprecated/org/apache/http/impl/io/AbstractSessionOutputBuffer.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java-deprecated/org/apache/http/impl/io/AbstractSessionOutputBuffer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java-deprecated/org/apache/http/impl/io/AbstractSessionOutputBuffer.java Fri Aug 29 00:06:53 2014
@@ -53,7 +53,7 @@ import org.apache.http.util.CharArrayBuf
* Abstract base class for session output buffers that stream data to
* an arbitrary {@link OutputStream}. This class buffers small chunks of
* output data in an internal byte array for optimal output performance.
- * </p>
+ * <p>
* {@link #writeLine(CharArrayBuffer)} and {@link #writeLine(String)} methods
* of this class use CR-LF as a line delimiter.
*
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/HttpEntity.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/HttpEntity.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/HttpEntity.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/HttpEntity.java Fri Aug 29 00:06:53 2014
@@ -147,7 +147,6 @@ public interface HttpEntity {
/**
* Writes the entity content out to the output stream.
* <p>
- * <p>
* IMPORTANT: Please note all entity implementations must ensure that
* all allocated resources are properly deallocated when this method
* returns.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/entity/ContentType.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/entity/ContentType.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/entity/ContentType.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/entity/ContentType.java Fri Aug 29 00:06:53 2014
@@ -51,7 +51,7 @@ import org.apache.http.util.TextUtils;
* <p>
* This class makes no attempts to verify validity of the MIME type.
* The input parameters of the {@link #create(String, String)} method, however, may not
- * contain characters <">, <;>, <,> reserved by the HTTP specification.
+ * contain characters {@code <">, <;>, <,>} reserved by the HTTP specification.
*
* @since 4.2
*/
@@ -167,7 +167,7 @@ public final class ContentType implement
* Creates a new instance of {@link ContentType}.
*
* @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
- * characters <">, <;>, <,> reserved by the HTTP specification.
+ * characters {@code <">, <;>, <,>} reserved by the HTTP specification.
* @param charset charset.
* @return content type
*/
@@ -181,7 +181,7 @@ public final class ContentType implement
* Creates a new instance of {@link ContentType} without a charset.
*
* @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
- * characters <">, <;>, <,> reserved by the HTTP specification.
+ * characters {@code <">, <;>, <,>} reserved by the HTTP specification.
* @return content type
*/
public static ContentType create(final String mimeType) {
@@ -192,8 +192,8 @@ public final class ContentType implement
* Creates a new instance of {@link ContentType}.
*
* @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
- * characters <">, <;>, <,> reserved by the HTTP specification.
- * @param charset charset. It may not contain characters <">, <;>, <,> reserved by the HTTP
+ * characters {@code <">, <;>, <,>} reserved by the HTTP specification.
+ * @param charset charset. It may not contain characters {@code <">, <;>, <,>} reserved by the HTTP
* specification. This parameter is optional.
* @return content type
* @throws UnsupportedCharsetException Thrown when the named charset is not available in
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/ContentLengthInputStream.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/ContentLengthInputStream.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/ContentLengthInputStream.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/ContentLengthInputStream.java Fri Aug 29 00:06:53 2014
@@ -203,7 +203,7 @@ public class ContentLengthInputStream ex
/**
* Skips and discards a number of bytes from the input stream.
* @param n The number of bytes to skip.
- * @return The actual number of bytes skipped. <= 0 if no bytes
+ * @return The actual number of bytes skipped. ≤ 0 if no bytes
* are skipped.
* @throws IOException If an error occurs while skipping bytes.
* @see InputStream#skip(long)
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SessionOutputBufferImpl.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SessionOutputBufferImpl.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SessionOutputBufferImpl.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SessionOutputBufferImpl.java Fri Aug 29 00:06:53 2014
@@ -48,7 +48,7 @@ import org.apache.http.util.CharArrayBuf
* Abstract base class for session output buffers that stream data to
* an arbitrary {@link OutputStream}. This class buffers small chunks of
* output data in an internal byte array for optimal output performance.
- * </p>
+ * <p>
* {@link #writeLine(CharArrayBuffer)} and {@link #writeLine(String)} methods
* of this class use CR-LF as a line delimiter.
*
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/util/LangUtils.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/util/LangUtils.java?rev=1621232&r1=1621231&r2=1621232&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/util/LangUtils.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/util/LangUtils.java Fri Aug 29 00:06:53 2014
@@ -68,7 +68,6 @@ public final class LangUtils {
/**
* Check if two object arrays are equal.
- * <p>
* <ul>
* <li>If both parameters are null, return {@code true}</li>
* <li>If one parameter is null, return {@code false}</li>