From 6efe9d9e64ce225275690ad7bb0c5619f9480409 Mon Sep 17 00:00:00 2001 From: Scott Leberknight <174812+sleberknight@users.noreply.github.com> Date: Wed, 29 May 2024 21:07:28 +0000 Subject: [PATCH] Replace "JAX-RS" in javadocs with "Jakarta REST" Closes #1136 --- .../java/org/kiwiproject/config/EndpointConfiguration.java | 6 +++--- src/main/java/org/kiwiproject/jaxrs/KiwiResources.java | 4 ++-- src/main/java/org/kiwiproject/jaxrs/KiwiResponses.java | 6 +++--- .../java/org/kiwiproject/jaxrs/KiwiStandardResponses.java | 4 ++-- .../org/kiwiproject/jaxrs/client/KiwiJerseyClients.java | 2 +- .../org/kiwiproject/jaxrs/client/WebTargetClientHelper.java | 2 +- .../java/org/kiwiproject/jaxrs/client/WebTargetHelper.java | 2 +- .../java/org/kiwiproject/jaxrs/exception/ErrorMessage.java | 2 +- .../org/kiwiproject/jaxrs/exception/JaxrsException.java | 2 +- .../java/org/kiwiproject/retry/KiwiRetryerPredicates.java | 4 ++-- src/main/java/org/kiwiproject/search/KiwiSearching.java | 4 ++-- .../java/org/kiwiproject/spring/data/PagingRequest.java | 6 +++--- .../java/org/kiwiproject/spring/data/PagingRequestTest.java | 4 ++-- 13 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/kiwiproject/config/EndpointConfiguration.java b/src/main/java/org/kiwiproject/config/EndpointConfiguration.java index 429fc5f4..0cb24bb3 100644 --- a/src/main/java/org/kiwiproject/config/EndpointConfiguration.java +++ b/src/main/java/org/kiwiproject/config/EndpointConfiguration.java @@ -290,11 +290,11 @@ private synchronized String getNextDomain() { } /** - * Converts the URI returned by {@link #getURI()} into a JAX-RS {@link UriBuilder}. + * Converts the URI returned by {@link #getURI()} into a Jakarta REST {@link UriBuilder}. *
- * Note that JAX-RS must be in the classpath when calling this method. + * Note that Jakarta REST must be in the classpath when calling this method. * - * @return a JAX-RS {@link UriBuilder} instance + * @return a new {@link UriBuilder} instance */ public UriBuilder toUriBuilder() { return UriBuilder.fromUri(getURI()); diff --git a/src/main/java/org/kiwiproject/jaxrs/KiwiResources.java b/src/main/java/org/kiwiproject/jaxrs/KiwiResources.java index 38cfbe88..8fa435eb 100644 --- a/src/main/java/org/kiwiproject/jaxrs/KiwiResources.java +++ b/src/main/java/org/kiwiproject/jaxrs/KiwiResources.java @@ -26,8 +26,8 @@ import java.util.Optional; /** - * Static utilities for use in JAX-RS resource classes. Contains utilities for verifying entities (e.g. obtained from - * a service or data access class), factories for creating new responses, and for validating query parameters. + * Static utilities for use in Jakarta REST resource classes. Contains utilities for verifying entities (e.g. obtained + * from a service or data access class), factories for creating new responses, and for validating query parameters. * * @apiNote Some methods in this class accept {@link Optional} arguments, which we know is considered a code smell * by various people and analysis tools such as IntelliJ's inspections, Sonar, etc. However, we also like to return diff --git a/src/main/java/org/kiwiproject/jaxrs/KiwiResponses.java b/src/main/java/org/kiwiproject/jaxrs/KiwiResponses.java index 013f63a5..f9596163 100644 --- a/src/main/java/org/kiwiproject/jaxrs/KiwiResponses.java +++ b/src/main/java/org/kiwiproject/jaxrs/KiwiResponses.java @@ -14,9 +14,9 @@ import java.util.function.Function; /** - * Static utilities related to evaluating and acting upon JAX-RS responses. For example, this class contains utilities - * to determine whether responses are successful or not, whether they are a specific type of response, and to perform - * actions (or throw exceptions) based on success or failure. + * Static utilities related to evaluating and acting upon Jakarta REST responses. For example, this class contains + * utilities to determine whether responses are successful or not, whether they are a specific type of response, and to + * perform actions (or throw exceptions) based on success or failure. *
* These utilities are intended mainly to be used in classes that make HTTP requests and need to evaluate and/or take * action with the HTTP responses. diff --git a/src/main/java/org/kiwiproject/jaxrs/KiwiStandardResponses.java b/src/main/java/org/kiwiproject/jaxrs/KiwiStandardResponses.java index 5a3f4847..df665b65 100644 --- a/src/main/java/org/kiwiproject/jaxrs/KiwiStandardResponses.java +++ b/src/main/java/org/kiwiproject/jaxrs/KiwiStandardResponses.java @@ -15,11 +15,11 @@ import java.util.Optional; /** - * A set of "standard" JAX-RS responses for various HTTP methods. The "standard" is simply Kiwi's view of + * A set of "standard" Jakarta REST responses for various HTTP methods. The "standard" is simply Kiwi's view of * what should be in responses for common HTTP methods in a REST-based interface using JSON as the primary * data format. *
- * These utilities are intended for use within JAX-RS resource classes. + * These utilities are intended for use within Jakarta REST resource classes. *
* One specific thing to note is that the content type is always set to {@link MediaType#APPLICATION_JSON}, since * the primary use case of this class assumes JSON-based REST interfaces. You can change the content type by diff --git a/src/main/java/org/kiwiproject/jaxrs/client/KiwiJerseyClients.java b/src/main/java/org/kiwiproject/jaxrs/client/KiwiJerseyClients.java index e89c94d7..f7deaf9a 100644 --- a/src/main/java/org/kiwiproject/jaxrs/client/KiwiJerseyClients.java +++ b/src/main/java/org/kiwiproject/jaxrs/client/KiwiJerseyClients.java @@ -10,7 +10,7 @@ import java.time.Duration; /** - * Static utilities related to Jersey {@link Client} instances. If these methods are used with a JAX-RS + * Static utilities related to Jersey {@link Client} instances. If these methods are used with a Jakarta REST * implementation other than Jersey, you should not expect anything to work. Some might fail silently, others could * throw unexpected exceptions, etc. *
diff --git a/src/main/java/org/kiwiproject/jaxrs/client/WebTargetClientHelper.java b/src/main/java/org/kiwiproject/jaxrs/client/WebTargetClientHelper.java index e0e451b4..cff52de9 100644 --- a/src/main/java/org/kiwiproject/jaxrs/client/WebTargetClientHelper.java +++ b/src/main/java/org/kiwiproject/jaxrs/client/WebTargetClientHelper.java @@ -10,7 +10,7 @@ import java.net.URI; /** - * Use with JAX-RS {@link Client} instances to provide additional functionality via {@link WebTargetHelper}. Each + * Use with Jakarta REST {@link Client} instances to provide additional functionality via {@link WebTargetHelper}. Each * of the {@code target} methods returns a {@link WebTargetHelper} to allow method chaining. Please see the * documentation in {@link WebTargetHelper} for more explanation. * diff --git a/src/main/java/org/kiwiproject/jaxrs/client/WebTargetHelper.java b/src/main/java/org/kiwiproject/jaxrs/client/WebTargetHelper.java index 27da4eeb..6edd8b1f 100644 --- a/src/main/java/org/kiwiproject/jaxrs/client/WebTargetHelper.java +++ b/src/main/java/org/kiwiproject/jaxrs/client/WebTargetHelper.java @@ -28,7 +28,7 @@ import java.util.stream.Stream; /** - * Use with JAX-RS {@link WebTarget} instances to provide convenient functionality when adding query parameters. + * Use with Jakarta REST {@link WebTarget} instances to provide convenient functionality when adding query parameters. * Most of this functionality is intended for cases when you only want to add parameters when they are not null (or not * blank in the case of Strings). If you want a query parameter to be added regardless of whether a value is present * or not, use the regular {@link WebTarget#queryParam(String, Object...) queryParam} method in {@code WebTarget}. diff --git a/src/main/java/org/kiwiproject/jaxrs/exception/ErrorMessage.java b/src/main/java/org/kiwiproject/jaxrs/exception/ErrorMessage.java index eeacc81e..a0ac324c 100644 --- a/src/main/java/org/kiwiproject/jaxrs/exception/ErrorMessage.java +++ b/src/main/java/org/kiwiproject/jaxrs/exception/ErrorMessage.java @@ -14,7 +14,7 @@ import java.util.Map; /** - * An error message that kiwi uses in JAX-RS related utilities. This is effectively a replacement for the + * An error message that kiwi uses in Jakarta REST related utilities. This is effectively a replacement for the * Dropwizard class of the same name. *
* Each instance contains the HTTP status (error) code; the error message; an optional identifier to identify the diff --git a/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsException.java b/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsException.java index 10ae13bd..7653c059 100644 --- a/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsException.java +++ b/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsException.java @@ -24,7 +24,7 @@ import java.util.Set; /** - * Represents a JAX-RS exception that uses the Kiwi {@link ErrorMessage} to describe + * Represents a Jakarta REST exception that uses the Kiwi {@link ErrorMessage} to describe * the errors causing this exception. *
* This class is concrete but also can be subclassed to represent specific HTTP status error codes.
diff --git a/src/main/java/org/kiwiproject/retry/KiwiRetryerPredicates.java b/src/main/java/org/kiwiproject/retry/KiwiRetryerPredicates.java
index 4cbe9fce..17414e21 100644
--- a/src/main/java/org/kiwiproject/retry/KiwiRetryerPredicates.java
+++ b/src/main/java/org/kiwiproject/retry/KiwiRetryerPredicates.java
@@ -67,13 +67,13 @@ public class KiwiRetryerPredicates {
ex instanceof NoRouteToHostException || getRootCause(ex) instanceof NoRouteToHostException;
/**
- * Check if a given JAX-RS {@link Response} is a client error (4xx).
+ * Check if a given Jakarta REST {@link Response} is a client error (4xx).
*/
public static final Predicate
- * Intended to be used in JAX-RS resource classes with HTTP {@link jakarta.ws.rs.GET} endpoint methods having an
+ * Intended to be used in Jakarta REST resource classes with HTTP {@link jakarta.ws.rs.GET} endpoint methods having an
* argument annotated with {@link jakarta.ws.rs.BeanParam}.
*
* Example:
@@ -25,7 +25,7 @@
* }
*
*
- * @implNote Requires Spring Data Commons and the JAX-RS API to be available at runtime.
+ * @implNote Requires Spring Data Commons and the Jakarta REST API to be available at runtime.
*/
@Getter
@Setter
diff --git a/src/test/java/org/kiwiproject/spring/data/PagingRequestTest.java b/src/test/java/org/kiwiproject/spring/data/PagingRequestTest.java
index ce9ae916..de687943 100644
--- a/src/test/java/org/kiwiproject/spring/data/PagingRequestTest.java
+++ b/src/test/java/org/kiwiproject/spring/data/PagingRequestTest.java
@@ -26,8 +26,8 @@
import org.springframework.data.domain.Sort;
/**
- * @implNote This test uses Dropwizard's (JAX-RS) test support classes to enable testing of
- * the JAX-RS annotations in {@link PagingRequest}.
+ * @implNote This test uses Dropwizard's (Jakarta REST) test support classes to enable testing of
+ * the Jakarta REST annotations in {@link PagingRequest}.
*/
@DisplayName("PagingRequest")
@ExtendWith({DropwizardExtensionsSupport.class, SoftAssertionsExtension.class})