Javadoc

- Add missing @throws tags

Author: garydgregory

httpcore5/src/main/java/org/apache/hc/core5/concurrent/CancellableDependency.java

@@ -37,6 +37,8 @@ public interface CancellableDependency extends Cancellable {
     /**
      * Sets {@link Cancellable} dependency on another ongoing process or
      * operation represented by {@link Cancellable}.
+     *
+     * @param cancellable another ongoing process or operation.
      */
     void setDependency(Cancellable cancellable);
 

httpcore5/src/main/java/org/apache/hc/core5/function/Callback.java

@@ -30,6 +30,7 @@
 /**
  * Abstract callback.
  *
+ * @param <T> The type of object consumed by the callback.
  * @since 5.0
  */
 @FunctionalInterface

httpcore5/src/main/java/org/apache/hc/core5/function/Decorator.java

@@ -30,6 +30,7 @@
 /**
  * Abstract decorator.
  *
+ * @param <T> The type of object to decorate.
  * @since 5.0
  */
 @FunctionalInterface

httpcore5/src/main/java/org/apache/hc/core5/function/Factory.java

@@ -30,6 +30,8 @@
 /**
  * Abstract object factory.
  *
+ * @param <P> The factory's input type.
+ * @param <T> The type of object produced by this factory.
  * @since 5.0
  */
 @FunctionalInterface

httpcore5/src/main/java/org/apache/hc/core5/function/Resolver.java

@@ -30,6 +30,8 @@
 /**
  * Abstract resolver from input to output.
  *
+ * @param <I> the input type.
+ * @param <O> the output type.
  * @since 5.0
  */
 @FunctionalInterface

httpcore5/src/main/java/org/apache/hc/core5/http/HttpRequestMapper.java

@@ -43,6 +43,7 @@ public interface HttpRequestMapper<T> {
      * @param request the request to map to a handler
      * @return HTTP request handler or {@code null} if no match
      * is found.
+     * @throws HttpException in case of an HTTP protocol violation.
      */
     T resolve(HttpRequest request, HttpContext context) throws HttpException;
 

httpcore5/src/main/java/org/apache/hc/core5/http/impl/io/DefaultBHttpClientConnection.java

@@ -180,6 +180,7 @@ public void bind(final Socket socket) throws IOException {
     }
 
     /**
+     * @throws IOException in case of an I/O error.
      * @since 5.3
      */
     public void bind(final SSLSocket sslSocket, final Socket baseSocket) throws IOException {

httpcore5/src/main/java/org/apache/hc/core5/http/impl/io/DefaultBHttpServerConnection.java

@@ -133,6 +133,7 @@ public void bind(final Socket socket) throws IOException {
     }
 
     /**
+     * @throws IOException in case of an I/O error.
      * @since 5.3
      */
     public void bind(final SSLSocket sslSocket, final Socket baseSocket) throws IOException {

httpcore5/src/main/java/org/apache/hc/core5/http/impl/nio/AbstractContentEncoder.java

@@ -108,7 +108,7 @@ protected void assertNotCompleted() {
      * Flushes content of the session buffer to the channel and updates transport metrics.
      *
      * @return number of bytes written to the channel.
-     *
+     * @throws IOException in case of an I/O error.
      * @since 4.3
      */
     protected int flushToChannel() throws IOException {
@@ -126,7 +126,7 @@ protected int flushToChannel() throws IOException {
      * Flushes content of the given buffer to the channel and updates transport metrics.
      *
      * @return number of bytes written to the channel.
-     *
+     * @throws IOException in case of an I/O error.
      * @since 4.3
      */
     protected int writeToChannel(final ByteBuffer src) throws IOException {
@@ -146,7 +146,7 @@ protected int writeToChannel(final ByteBuffer src) throws IOException {
      * @param src source.
      * @param limit max number of bytes to transfer.
      * @return number of bytes transferred.
-     *
+     * @throws IOException in case of an I/O error.
      * @since 4.3
      */
     protected int writeToChannel(final ByteBuffer src, final int limit) throws IOException {
@@ -159,7 +159,7 @@ protected int writeToChannel(final ByteBuffer src, final int limit) throws IOExc
      * @param src source.
      * @param limit max number of bytes to transfer.
      * @return number of bytes transferred.
-     *
+     * @throws IOException in case of an I/O error.
      * @since 4.3
      */
     protected int writeToBuffer(final ByteBuffer src, final int limit) throws IOException {

httpcore5/src/main/java/org/apache/hc/core5/http/impl/nio/AbstractMessageWriter.java

@@ -79,6 +79,7 @@ public void reset() {
      * Writes out the first line of {@link HttpMessage}.
      *
      * @param message HTTP message.
+     * @throws IOException in case of an I/O error.
      */
     protected abstract void writeHeadLine(T message, CharArrayBuffer buffer) throws IOException;