Javadoc and reduce boilerplate

- Use for-each loop instead of iterator() - Use forEach() API - Use lambdas instead of anonymous inner class - Use method reference - Use final - Use blocks
apache · Sep 16, 2024 · 5ccfeca · 5ccfeca
1 parent aec14c4
commit 5ccfeca
Show file tree

Hide file tree

Showing 36 changed files with 174 additions and 281 deletions.
diff --git a/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/hpack/HPackEncoder.java b/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/hpack/HPackEncoder.java
@@ -243,8 +243,7 @@ private int findFullMatch(final List<HPackEntry> entries, final String value) {
         if (entries == null || entries.isEmpty()) {
             return 0;
         }
-        for (int i = 0; i < entries.size(); i++) {
-            final HPackEntry entry = entries.get(i);
+        for (final HPackEntry entry : entries) {
             if (Objects.equals(value, entry.getHeader().getValue())) {
                 return entry.getIndex();
             }
@@ -303,8 +302,8 @@ void encodeHeader(
     void encodeHeaders(
             final ByteArrayBuffer dst, final List<? extends Header> headers,
             final boolean noIndexing, final boolean useHuffman) throws CharacterCodingException {
-        for (int i = 0; i < headers.size(); i++) {
-            encodeHeader(dst, headers.get(i), noIndexing, useHuffman);
+        for (final Header header : headers) {
+            encodeHeader(dst, header, noIndexing, useHuffman);
         }
     }
 

diff --git a/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/DefaultH2RequestConverter.java b/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/DefaultH2RequestConverter.java
@@ -150,9 +150,7 @@ public HttpRequest convert(final List<Header> headers) throws HttpException {
             throw new ProtocolException(ex.getMessage(), ex);
         }
         httpRequest.setPath(path);
-        for (int i = 0; i < messageHeaders.size(); i++) {
-            httpRequest.addHeader(messageHeaders.get(i));
-        }
+        messageHeaders.forEach(httpRequest::addHeader);
         return httpRequest;
     }
 

diff --git a/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/DefaultH2ResponseConverter.java b/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/DefaultH2ResponseConverter.java
@@ -102,9 +102,7 @@ public HttpResponse convert(final List<Header> headers) throws HttpException {
         }
         final HttpResponse response = new BasicHttpResponse(statusCode, null);
         response.setVersion(HttpVersion.HTTP_2);
-        for (int i = 0; i < messageHeaders.size(); i++) {
-            response.addHeader(messageHeaders.get(i));
-        }
+        messageHeaders.forEach(response::addHeader);
         return response;
     }
 

diff --git a/...ore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/AbstractH2StreamMultiplexer.java b/...ore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/AbstractH2StreamMultiplexer.java
@@ -36,6 +36,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Queue;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentLinkedDeque;
@@ -478,8 +479,7 @@ public final void onOutput() throws HttpException, IOException {
             final int pendingOutputRequests = outputRequests.get();
             boolean outputPending = false;
             if (!streamMap.isEmpty() && connOutputWindow.get() > 0) {
-                for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-                    final Map.Entry<Integer, H2Stream> entry = it.next();
+                for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
                     final H2Stream stream = entry.getValue();
                     if (!stream.isLocalClosed()
                             && stream.getOutputWindow().get() > 0
@@ -553,8 +553,7 @@ public final void onTimeout(final Timeout timeout) throws HttpException, IOExcep
                             "Timeout due to inactivity (" + timeout + ")");
         }
         commitFrame(goAway);
-        for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-            final Map.Entry<Integer, H2Stream> entry = it.next();
+        for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
             final H2Stream stream = entry.getValue();
             stream.reset(new H2StreamResetException(H2Error.NO_ERROR, "Timeout due to inactivity (" + timeout + ")"));
         }
@@ -570,8 +569,7 @@ public final void onDisconnect() {
                 break;
             }
         }
-        for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-            final Map.Entry<Integer, H2Stream> entry = it.next();
+        for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
             final H2Stream stream = entry.getValue();
             stream.cancel();
         }
@@ -598,8 +596,7 @@ private void processPendingCommands() throws IOException, HttpException {
             if (command instanceof ShutdownCommand) {
                 final ShutdownCommand shutdownCommand = (ShutdownCommand) command;
                 if (shutdownCommand.getType() == CloseMode.IMMEDIATE) {
-                    for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-                        final Map.Entry<Integer, H2Stream> entry = it.next();
+                    for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
                         final H2Stream stream = entry.getValue();
                         stream.cancel();
                     }
@@ -673,8 +670,7 @@ public final void onException(final Exception cause) {
                     break;
                 }
             }
-            for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-                final Map.Entry<Integer, H2Stream> entry = it.next();
+            for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
                 final H2Stream stream = entry.getValue();
                 stream.reset(cause);
             }
@@ -1009,8 +1005,7 @@ private void consumeFrame(final RawFrame frame) throws HttpException, IOExceptio
                     }
                     connState = streamMap.isEmpty() ? ConnectionHandshake.SHUTDOWN : ConnectionHandshake.GRACEFUL_SHUTDOWN;
                 } else {
-                    for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-                        final Map.Entry<Integer, H2Stream> entry = it.next();
+                    for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
                         final H2Stream stream = entry.getValue();
                         stream.reset(new H2StreamResetException(errorCode, "Connection terminated by the peer (" + errorCode + ")"));
                     }
@@ -1233,8 +1228,7 @@ private void applyRemoteSettings(final H2Config config) throws H2ConnectionExcep
 
         if (delta != 0) {
             if (!streamMap.isEmpty()) {
-                for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-                    final Map.Entry<Integer, H2Stream> entry = it.next();
+                for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
                     final H2Stream stream = entry.getValue();
                     try {
                         updateOutputWindow(stream.getId(), stream.getOutputWindow(), delta);
@@ -1254,8 +1248,7 @@ private void applyLocalSettings() throws H2ConnectionException {
         initInputWinSize = localConfig.getInitialWindowSize();
 
         if (delta != 0 && !streamMap.isEmpty()) {
-            for (final Iterator<Map.Entry<Integer, H2Stream>> it = streamMap.entrySet().iterator(); it.hasNext(); ) {
-                final Map.Entry<Integer, H2Stream> entry = it.next();
+            for (final Entry<Integer, H2Stream> entry : streamMap.entrySet()) {
                 final H2Stream stream = entry.getValue();
                 try {
                     updateInputWindow(stream.getId(), stream.getInputWindow(), delta);

diff --git a/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/ServerH2PrefaceHandler.java b/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/ServerH2PrefaceHandler.java
@@ -85,8 +85,8 @@ public void inputReady(final IOSession session, final ByteBuffer src) throws IOE
         }
         final ByteBuffer data = inBuf.data();
         if (data.remaining() >= PREFACE.length) {
-            for (int i = 0; i < PREFACE.length; i++) {
-                if (data.get() != PREFACE[i]) {
+            for (final byte element : PREFACE) {
+                if (data.get() != element) {
                     throw new ProtocolNegotiationException("Unexpected HTTP/2 preface");
                 }
             }

diff --git a/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/support/BasicPingHandler.java b/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/support/BasicPingHandler.java
@@ -57,8 +57,8 @@ public ByteBuffer getData() {
     @Override
     public void consumeResponse(final ByteBuffer feedback) throws HttpException, IOException {
         boolean result = true;
-        for (int i = 0; i < PING_MESSAGE.length; i++) {
-            if (!feedback.hasRemaining() || PING_MESSAGE[i] != feedback.get()) {
+        for (final byte element : PING_MESSAGE) {
+            if (!feedback.hasRemaining() || element != feedback.get()) {
                 result = false;
                 break;
             }

diff --git a/.../src/test/java/org/apache/hc/core5/http2/examples/H2ConscriptRequestExecutionExample.java b/.../src/test/java/org/apache/hc/core5/http2/examples/H2ConscriptRequestExecutionExample.java
@@ -77,16 +77,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2FileServerExample.java b/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2FileServerExample.java
@@ -94,16 +94,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2FullDuplexClientExample.java b/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2FullDuplexClientExample.java
@@ -82,16 +82,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2FullDuplexServerExample.java b/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2FullDuplexServerExample.java
@@ -88,16 +88,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/...e5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2MultiStreamExecutionExample.java b/...e5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2MultiStreamExecutionExample.java
@@ -76,16 +76,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2RequestExecutionExample.java b/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/examples/H2RequestExecutionExample.java
@@ -68,16 +68,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/...h2/src/test/java/org/apache/hc/core5/http2/examples/H2TlsAlpnRequestExecutionExample.java b/...h2/src/test/java/org/apache/hc/core5/http2/examples/H2TlsAlpnRequestExecutionExample.java
@@ -77,16 +77,12 @@ public static void main(final String[] args) throws Exception {
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/...-h2/src/test/java/org/apache/hc/core5/http2/examples/H2ViaHttp1ProxyExecutionExample.java b/...-h2/src/test/java/org/apache/hc/core5/http2/examples/H2ViaHttp1ProxyExecutionExample.java
@@ -103,16 +103,12 @@ public void onExchangeComplete(final HttpConnection connection, final boolean ke
 
                     @Override
                     public void onHeaderInput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") << " + header));
                     }
 
                     @Override
                     public void onHeaderOutput(final HttpConnection connection, final int streamId, final List<? extends Header> headers) {
-                        for (int i = 0; i < headers.size(); i++) {
-                            System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + headers.get(i));
-                        }
+                        headers.forEach(header -> System.out.println(connection.getRemoteAddress() + " (" + streamId + ") >> " + header));
                     }
 
                     @Override

diff --git a/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/hpack/TestHPackCoding.java b/httpcore5-h2/src/test/java/org/apache/hc/core5/http2/hpack/TestHPackCoding.java
@@ -254,14 +254,16 @@ void testEnsureCapacity() throws Exception {
     };
 
     private static String constructHelloString(final int[] raw, final int n) {
+        final StringBuilder str = new StringBuilder(raw.length);
+        for (final int element : raw) {
+            str.append((char) element);
+        }
         final StringBuilder buffer = new StringBuilder();
         for (int j = 0; j < n; j++) {
             if (j > 0) {
                 buffer.append("; ");
             }
-            for (int i = 0; i < raw.length; i++) {
-                buffer.append((char) raw[i]);
-            }
+            buffer.append(str);
         }
         return buffer.toString();
     }

diff --git a/.../src/test/java/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexServerExample.java b/.../src/test/java/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexServerExample.java
@@ -68,7 +68,7 @@ public static void main(final String[] args) throws Exception {
             .build();
 
         final HttpAsyncServer server = AsyncServerBootstrap.bootstrap()
-            .setExceptionCallback(e -> e.printStackTrace())
+            .setExceptionCallback(Exception::printStackTrace)
             .setIOReactorConfig(config)
             .setStreamListener(new Http1StreamListener() {
                 @Override