added javadoc descriptions for constants

devonfw · Mar 31, 2023 · 1a081e2 · 1a081e2
1 parent beb7248
commit 1a081e2
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/...a/com/devonfw/cobigen/retriever/mavensearch/constants/MavenSearchRepositoryConstants.java b/...a/com/devonfw/cobigen/retriever/mavensearch/constants/MavenSearchRepositoryConstants.java
@@ -5,22 +5,49 @@
  */
 public class MavenSearchRepositoryConstants {
 
+  /**
+   * Message for an exception when an unexpected status code was returned by the API
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_UNEXPECTED_STATUS_CODE = "The search REST API returned the unexpected status code";
 
+  /**
+   * Message for an exception when no response was returned by the API
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_NO_RESPONSE = "It was not possible to get a response from";
 
+  /**
+   * Message for an exception when the request to the API failed
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_REQUEST_FAILED = "The search REST API was unable to send or receive the message from the service using the URL";
 
+  /**
+   * Message for an exception when a faulty target URL was provided
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_FAULTY_TARGET_URL = "CobiGen was unable to retrieve valid URLs from the REST Search API of the";
 
+  /**
+   * Message for an exception when an empty response was returned by the API
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_EMPTY_JSON_RESPONSE = "The search REST API recieved an empty json response from the target URL";
 
+  /**
+   * Message for an exception when an empty artifact list was returned by the API
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_ARTIFACT_LIST_EMPTY = "CobiGen did not find any artifacts using the REST Search API of the";
 
+  /**
+   * Message part one for an exception when the authentication for an API failed
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_AUTH_FAILED_ONE = "CobiGen was unable to access the REST Search API of the";
 
+  /**
+   * Message part two for an exception when the authentication for an API failed
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_AUTH_FAILED_TWO = "repository with authentication method: Basic Authentication using the URL";
 
+  /**
+   * Message for an exception when the API response json could not be parsed
+   */
   public static final String MAVEN_SEARCH_API_EXCEPTION_UNABLE_TO_PARSE_JSON = "CobiGen was unable to parse the json response from the REST Search API of the";
 
   /**