You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2025/12/06 18:27:19 UTC
(httpcomponents-client) 02/02: Corrected @since tags
This is an automated email from the ASF dual-hosted git repository.
olegk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/httpcomponents-client.git
commit c82268d7f8904c0fb6879a60247b5c30feb7ea67
Author: Oleg Kalnichevski <ol...@apache.org>
AuthorDate: Sat Dec 6 19:16:16 2025 +0100
Corrected @since tags
---
.../impl/cache/AbstractSerializingCacheStorage.java | 2 +-
.../impl/cache/caffeine/CaffeineHttpCacheStorage.java | 2 +-
.../cache/memcached/MemcachedHttpCacheStorage.java | 2 +-
.../org/apache/hc/client5/http/sse/EventSource.java | 18 +++++++++---------
.../apache/hc/client5/http/sse/EventSourceConfig.java | 18 +++++++++---------
.../hc/client5/http/sse/EventSourceListener.java | 10 +++++-----
.../org/apache/hc/client5/http/sse/SseExecutor.java | 2 +-
.../apache/hc/client5/http/sse/SseExecutorBuilder.java | 2 +-
.../hc/client5/http/sse/impl/DefaultEventSource.java | 2 +-
.../http/sse/impl/ExponentialJitterBackoff.java | 6 +++---
.../hc/client5/http/sse/impl/FixedBackoffStrategy.java | 6 +++---
.../hc/client5/http/sse/impl/NoBackoffStrategy.java | 6 +++---
.../apache/hc/client5/http/sse/impl/SseCallbacks.java | 2 +-
.../hc/client5/http/sse/impl/SseEntityConsumer.java | 2 +-
.../org/apache/hc/client5/http/sse/impl/SseParser.java | 2 +-
.../hc/client5/http/sse/impl/SseResponseConsumer.java | 2 +-
.../apache/hc/client5/http/sse/impl/package-info.java | 2 +-
.../org/apache/hc/client5/http/sse/package-info.java | 2 +-
18 files changed, 44 insertions(+), 44 deletions(-)
diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorage.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorage.java
index b0a24d328..8f01a7f40 100644
--- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorage.java
+++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorage.java
@@ -62,7 +62,7 @@ public AbstractSerializingCacheStorage(final int maxUpdateRetries, final HttpCac
protected abstract void store(String storageKey, T storageObject) throws ResourceIOException;
/**
- * @since 5.6
+ * @since 5.7
*/
protected void store(final String storageKey, final Instant expectedExpiry, final T storageObject) throws ResourceIOException {
store(storageKey, storageObject);
diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/caffeine/CaffeineHttpCacheStorage.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/caffeine/CaffeineHttpCacheStorage.java
index 293c092f5..d0daa3252 100644
--- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/caffeine/CaffeineHttpCacheStorage.java
+++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/caffeine/CaffeineHttpCacheStorage.java
@@ -55,7 +55,7 @@
* <p>Please refer to the Caffeine documentation for details on how to
* configure the cache itself.</p>
*
- * @since 5.6
+ * @since 5.7
*/
public class CaffeineHttpCacheStorage<T> extends AbstractSerializingCacheStorage<T, T> {
diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheStorage.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheStorage.java
index 3b62d2282..d9b63d2b9 100644
--- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheStorage.java
+++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheStorage.java
@@ -165,7 +165,7 @@ public MemcachedHttpCacheStorage(
* @param keyHashingScheme how to map higher-level logical "storage keys"
* onto "cache keys" suitable for use with memcached
* @param expiryResolver resolver for cache entry expiry
- * @since 5.6
+ * @since 5.7
*/
public MemcachedHttpCacheStorage(
final MemcachedClientIF client,
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSource.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSource.java
index 722ca3029..bf472dd43 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSource.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSource.java
@@ -49,7 +49,7 @@
* id is remembered by the implementation and can be sent on subsequent reconnects
* so the server can resume the stream.</p>
*
- * @since 5.6
+ * @since 5.7
*/
@Contract
public interface EventSource {
@@ -62,7 +62,7 @@ public interface EventSource {
* <li>Reconnects: implementation-specific and driven by configuration.</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
void start();
@@ -74,7 +74,7 @@ public interface EventSource {
* {@code onClosed()} exactly once.</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
void cancel();
@@ -82,7 +82,7 @@ public interface EventSource {
* Returns the last seen event id or {@code null} if none has been observed.
*
* @return the last event id, or {@code null}
- * @since 5.6
+ * @since 5.7
*/
String lastEventId();
@@ -91,7 +91,7 @@ public interface EventSource {
* or reconnect attempt. Passing {@code null} clears the value.
*
* @param id the id to send, or {@code null} to clear
- * @since 5.6
+ * @since 5.7
*/
void setLastEventId(String id);
@@ -101,7 +101,7 @@ public interface EventSource {
*
* @param name header name (non-null)
* @param value header value (may be empty but not null)
- * @since 5.6
+ * @since 5.7
*/
void setHeader(String name, String value);
@@ -109,7 +109,7 @@ public interface EventSource {
* Removes a previously set request header for subsequent (re)connects.
*
* @param name header name to remove (non-null)
- * @since 5.6
+ * @since 5.7
*/
void removeHeader(String name);
@@ -119,7 +119,7 @@ public interface EventSource {
* by the caller without affecting the {@code EventSource}.
*
* @return copy of headers to be sent
- * @since 5.6
+ * @since 5.7
*/
Map<String, String> getHeaders();
@@ -128,7 +128,7 @@ public interface EventSource {
* Implementations may report {@code false} during backoff between reconnects.
*
* @return {@code true} if the transport is open and events may be received
- * @since 5.6
+ * @since 5.7
*/
boolean isConnected();
}
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceConfig.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceConfig.java
index ca866abd6..f8a8700a9 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceConfig.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceConfig.java
@@ -48,7 +48,7 @@
* <h3>Thread-safety</h3>
* <p>Instances are immutable and thread-safe.</p>
*
- * @since 5.6
+ * @since 5.7
*/
public final class EventSourceConfig {
@@ -58,7 +58,7 @@ public final class EventSourceConfig {
* <p>See {@link BackoffStrategy} for the contract. The default is
* {@link ExponentialJitterBackoff} with base=1000 ms, max=30000 ms, factor=2.0, min=250 ms.</p>
*
- * @since 5.6
+ * @since 5.7
*/
public final BackoffStrategy backoff;
@@ -70,7 +70,7 @@ public final class EventSourceConfig {
* <li>{@code >0}: number of attempts after the initial connect.</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
public final int maxReconnects;
@@ -81,7 +81,7 @@ public final class EventSourceConfig {
* <li>{@link #maxReconnects} = {@code -1} (unlimited)</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
public static final EventSourceConfig DEFAULT = builder().build();
@@ -94,7 +94,7 @@ private EventSourceConfig(final BackoffStrategy backoff, final int maxReconnects
* Creates a new builder initialized with sensible defaults.
*
* @return a new {@link Builder}
- * @since 5.6
+ * @since 5.7
*/
public static Builder builder() {
return new Builder();
@@ -105,7 +105,7 @@ public static Builder builder() {
*
* <p>Not thread-safe.</p>
*
- * @since 5.6
+ * @since 5.7
*/
public static final class Builder {
private BackoffStrategy backoff =
@@ -118,7 +118,7 @@ public static final class Builder {
* @param backoff non-null strategy implementation (e.g., {@link ExponentialJitterBackoff}
* or a custom {@link BackoffStrategy})
* @return this builder
- * @since 5.6
+ * @since 5.7
*/
public Builder backoff(final BackoffStrategy backoff) {
this.backoff = Objects.requireNonNull(backoff, "backoff");
@@ -132,7 +132,7 @@ public Builder backoff(final BackoffStrategy backoff) {
*
* @param nmaxReconnects max attempts
* @return this builder
- * @since 5.6
+ * @since 5.7
*/
public Builder maxReconnects(final int nmaxReconnects) {
this.maxReconnects = nmaxReconnects;
@@ -143,7 +143,7 @@ public Builder maxReconnects(final int nmaxReconnects) {
* Builds an immutable {@link EventSourceConfig}.
*
* @return the config
- * @since 5.6
+ * @since 5.7
*/
public EventSourceConfig build() {
return new EventSourceConfig(backoff, maxReconnects);
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceListener.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceListener.java
index a8ee5440c..81de3223e 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceListener.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/EventSourceListener.java
@@ -55,7 +55,7 @@
* closed (either by {@link EventSource#cancel()} or after giving up on reconnects).</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
@FunctionalInterface
public interface EventSourceListener {
@@ -66,14 +66,14 @@ public interface EventSourceListener {
* @param id the event id, or {@code null} if not present
* @param type the event type, or {@code null} (treat as {@code "message"})
* @param data the event data (never {@code null})
- * @since 5.6
+ * @since 5.7
*/
void onEvent(String id, String type, String data);
/**
* Called when the SSE stream is opened and ready to receive events.
*
- * @since 5.6
+ * @since 5.7
*/
default void onOpen() {
}
@@ -81,7 +81,7 @@ default void onOpen() {
/**
* Called once when the stream is permanently closed (no further reconnects).
*
- * @since 5.6
+ * @since 5.7
*/
default void onClosed() {
}
@@ -95,7 +95,7 @@ default void onClosed() {
*
* @param t the failure cause (never {@code null})
* @param willReconnect {@code true} if a reconnect has been scheduled
- * @since 5.6
+ * @since 5.7
*/
default void onFailure(final Throwable t, final boolean willReconnect) {
}
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutor.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutor.java
index b65dad79e..69fa3447a 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutor.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutor.java
@@ -80,7 +80,7 @@
* es.start();
* }</pre>
*
- * @since 5.6
+ * @since 5.7
*/
public final class SseExecutor {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutorBuilder.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutorBuilder.java
index 1ee2e699e..b03356513 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutorBuilder.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/SseExecutorBuilder.java
@@ -60,7 +60,7 @@
* .build();
* }</pre>
*
- * @since 5.6
+ * @since 5.7
*/
public final class SseExecutorBuilder {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/DefaultEventSource.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/DefaultEventSource.java
index 0807f8d8c..021121264 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/DefaultEventSource.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/DefaultEventSource.java
@@ -86,7 +86,7 @@
*
* <p><strong>Internal:</strong> this class is not part of the public API and can change without notice.</p>
*
- * @since 5.6
+ * @since 5.7
*/
@Internal
public final class DefaultEventSource implements EventSource {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/ExponentialJitterBackoff.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/ExponentialJitterBackoff.java
index 16e75a389..0fc928f1b 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/ExponentialJitterBackoff.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/ExponentialJitterBackoff.java
@@ -49,7 +49,7 @@
*
* <p>This strategy is stateless and thread-safe.</p>
*
- * @since 5.6
+ * @since 5.7
*/
public final class ExponentialJitterBackoff implements BackoffStrategy {
@@ -80,7 +80,7 @@ public final class ExponentialJitterBackoff implements BackoffStrategy {
* @param maxMs maximum delay in milliseconds (will be coerced to ≥ baseMs)
* @param factor exponential growth factor (will be coerced to ≥ 1.0)
* @param minMs minimum delay in milliseconds (will be coerced to ≥ 0)
- * @since 5.6
+ * @since 5.7
*/
public ExponentialJitterBackoff(final long baseMs, final long maxMs, final double factor, final long minMs) {
this.baseMs = Math.max(1, baseMs);
@@ -108,7 +108,7 @@ public ExponentialJitterBackoff(final long baseMs, final long maxMs, final doubl
* @param serverRetryHintMs value from server {@code retry:} (ms) or HTTP {@code Retry-After}
* converted to ms; {@code null} if none
* @return delay in milliseconds (≥ 0)
- * @since 5.6
+ * @since 5.7
*/
@Override
public long nextDelayMs(final int attempt, final long previousDelayMs, final Long serverRetryHintMs) {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/FixedBackoffStrategy.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/FixedBackoffStrategy.java
index 28867fb9d..2fe06b360 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/FixedBackoffStrategy.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/FixedBackoffStrategy.java
@@ -47,7 +47,7 @@
*
* @see BackoffStrategy
* @see EventSourceConfig
- * @since 5.6
+ * @since 5.7
*/
public final class FixedBackoffStrategy implements BackoffStrategy {
@@ -60,7 +60,7 @@ public final class FixedBackoffStrategy implements BackoffStrategy {
* Creates a fixed-delay backoff strategy.
*
* @param delayMs constant delay in milliseconds (negative values are coerced to {@code 0})
- * @since 5.6
+ * @since 5.7
*/
public FixedBackoffStrategy(final long delayMs) {
this.delayMs = Math.max(0L, delayMs);
@@ -76,7 +76,7 @@ public FixedBackoffStrategy(final long delayMs) {
* @param previousDelayMs last delay used (ignored)
* @param serverRetryHintMs server-provided retry delay in ms, or {@code null}
* @return delay in milliseconds (always {@code >= 0})
- * @since 5.6
+ * @since 5.7
*/
@Override
public long nextDelayMs(final int attempt, final long previousDelayMs, final Long serverRetryHintMs) {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/NoBackoffStrategy.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/NoBackoffStrategy.java
index d4b236d5e..f0c9585ef 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/NoBackoffStrategy.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/NoBackoffStrategy.java
@@ -43,7 +43,7 @@
*
* <p>Stateless and thread-safe.</p>
*
- * @since 5.6
+ * @since 5.7
*/
public final class NoBackoffStrategy implements BackoffStrategy {
@@ -55,7 +55,7 @@ public final class NoBackoffStrategy implements BackoffStrategy {
* @param previousDelayMs last delay used (unused)
* @param serverRetryHintMs server-provided retry hint (unused)
* @return {@code 0}
- * @since 5.6
+ * @since 5.7
*/
@Override
public long nextDelayMs(final int attempt, final long previousDelayMs, final Long serverRetryHintMs) {
@@ -69,7 +69,7 @@ public long nextDelayMs(final int attempt, final long previousDelayMs, final Lon
* @param previousDelayMs last delay used (unused)
* @param serverRetryHintMs server-provided retry hint (unused)
* @return {@code false}
- * @since 5.6
+ * @since 5.7
*/
@Override
public boolean shouldReconnect(final int attempt, final long previousDelayMs, final Long serverRetryHintMs) {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseCallbacks.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseCallbacks.java
index d7c9738f4..4d480f239 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseCallbacks.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseCallbacks.java
@@ -37,7 +37,7 @@
* public API. Methods may be invoked on I/O or decoder threads;
* implementations must be lightweight and non-blocking.</p>
*
- * @since 5.6
+ * @since 5.7
*/
@Internal
public interface SseCallbacks {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseEntityConsumer.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseEntityConsumer.java
index 8da5086d9..5b90d4e72 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseEntityConsumer.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseEntityConsumer.java
@@ -56,7 +56,7 @@
* <p><strong>Thread-safety:</strong> Not thread-safe. One instance is expected to be
* used by a single decoding flow on an I/O thread.</p>
*
- * @since 5.6
+ * @since 5.7
*/
@Internal
public final class SseEntityConsumer extends AbstractCharAsyncEntityConsumer<Void>
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseParser.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseParser.java
index 896c57cf2..b71d96a89 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseParser.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseParser.java
@@ -36,7 +36,7 @@
* string allocation. Can be slightly faster at very high rates.</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
public enum SseParser {
/**
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseResponseConsumer.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseResponseConsumer.java
index 7f175312b..6b64b8cb9 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseResponseConsumer.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/SseResponseConsumer.java
@@ -62,7 +62,7 @@
*
* <p>This class is used internally by {@code DefaultEventSource}.</p>
*
- * @since 5.6
+ * @since 5.7
*/
@Internal
public final class SseResponseConsumer implements AsyncResponseConsumer<Void> {
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/package-info.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/package-info.java
index d9218f642..ce626ddd7 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/package-info.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/impl/package-info.java
@@ -52,6 +52,6 @@
* <li>{@link org.apache.hc.client5.http.sse.impl.SseParser}</li>
* </ul>
*
- * @since 5.6
+ * @since 5.7
*/
package org.apache.hc.client5.http.sse.impl;
diff --git a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java
index 16df55b88..776dd9f6b 100644
--- a/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java
+++ b/httpclient5-sse/src/main/java/org/apache/hc/client5/http/sse/package-info.java
@@ -130,6 +130,6 @@
* and the concrete entity consumers) are not part of the public API and may
* change without notice.</p>
*
- * @since 5.6
+ * @since 5.7
*/
package org.apache.hc.client5.http.sse;