Mark QUERY impl as @experimental

apache · Oct 19, 2024 · af10afd · garydgregory · Oct 19, 2024 · af10afd
1 parent 731e683
commit af10afd
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 1 deletion.
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/annotation/Experimental.java b/httpcore5/src/main/java/org/apache/hc/core5/annotation/Experimental.java
@@ -36,7 +36,8 @@
  * The field or method to which this annotation is applied is marked as experimental.
  */
 @Documented
-@Target({ElementType.METHOD, ElementType.TYPE})
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.FIELD})
 @Retention(RetentionPolicy.CLASS)
 public @interface Experimental {
+    String reason() default "";
 }
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/Method.java b/httpcore5/src/main/java/org/apache/hc/core5/http/Method.java
@@ -29,6 +29,7 @@
 
 import java.util.Locale;
 
+import org.apache.hc.core5.annotation.Experimental;
 import org.apache.hc.core5.util.Args;
 
 /**
@@ -103,6 +104,7 @@ public enum Method {
      *
      * @since 5.4
      */
+    @Experimental(reason = "QUERY method is still in DRAFT status")
     QUERY(true, true);
 
     private final boolean safe;

diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/io/support/ClassicRequestBuilder.java b/httpcore5/src/main/java/org/apache/hc/core5/http/io/support/ClassicRequestBuilder.java
@@ -33,6 +33,7 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.hc.core5.annotation.Experimental;
 import org.apache.hc.core5.http.ClassicHttpRequest;
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.Header;
@@ -127,6 +128,7 @@ public static ClassicRequestBuilder head(final String uri) {
      *
      * @since 5.4
      */
+    @Experimental
     public static ClassicRequestBuilder query() {
         return new ClassicRequestBuilder(Method.QUERY);
     }
@@ -139,6 +141,7 @@ public static ClassicRequestBuilder query() {
      *
      * @since 5.4
      */
+    @Experimental
     public static ClassicRequestBuilder query(final URI uri) {
         return new ClassicRequestBuilder(Method.QUERY, uri);
     }
@@ -151,6 +154,7 @@ public static ClassicRequestBuilder query(final URI uri) {
      *
      * @since 5.4
      */
+    @Experimental
     public static ClassicRequestBuilder query(final String uri) {
         return new ClassicRequestBuilder(Method.QUERY, uri);
     }

diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/nio/support/AsyncRequestBuilder.java b/httpcore5/src/main/java/org/apache/hc/core5/http/nio/support/AsyncRequestBuilder.java
@@ -33,6 +33,7 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.hc.core5.annotation.Experimental;
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.http.HttpHost;
@@ -127,6 +128,7 @@ public static AsyncRequestBuilder head(final String uri) {
      *
      * @since 5.4
      */
+    @Experimental
     public static AsyncRequestBuilder query() {
         return new AsyncRequestBuilder(Method.QUERY);
     }
@@ -139,6 +141,7 @@ public static AsyncRequestBuilder query() {
      *
      * @since 5.4
      */
+    @Experimental
     public static AsyncRequestBuilder query(final URI uri) {
         return new AsyncRequestBuilder(Method.QUERY, uri);
     }
@@ -151,6 +154,7 @@ public static AsyncRequestBuilder query(final URI uri) {
      *
      * @since 5.4
      */
+    @Experimental
     public static AsyncRequestBuilder query(final String uri) {
         return new AsyncRequestBuilder(Method.QUERY, uri);
     }

diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/support/BasicRequestBuilder.java b/httpcore5/src/main/java/org/apache/hc/core5/http/support/BasicRequestBuilder.java
@@ -33,6 +33,7 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.hc.core5.annotation.Experimental;
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.http.HttpHost;
 import org.apache.hc.core5.http.HttpRequest;
@@ -111,6 +112,7 @@ public static BasicRequestBuilder head(final String uri) {
      *
      * @since 5.4
      */
+    @Experimental
     public static BasicRequestBuilder query() {
         return new BasicRequestBuilder(Method.QUERY);
     }
@@ -123,6 +125,7 @@ public static BasicRequestBuilder query() {
      *
      * @since 5.4
      */
+    @Experimental
     public static BasicRequestBuilder query(final URI uri) {
         return new BasicRequestBuilder(Method.QUERY, uri);
     }
@@ -135,6 +138,7 @@ public static BasicRequestBuilder query(final URI uri) {
      *
      * @since 5.4
      */
+    @Experimental
     public static BasicRequestBuilder query(final String uri) {
         return new BasicRequestBuilder(Method.QUERY, uri);
     }