You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by jo...@apache.org on 2022/06/02 16:37:20 UTC
[sling-org-apache-sling-testing-clients] 03/03: add a bit more javadoc
This is an automated email from the ASF dual-hosted git repository.
joerghoh pushed a commit to branch SLING-11364-more-precise-exceptions-2
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-clients.git
commit 01a10c8516693ed66f1c434a7eec22accb2a58bd
Author: Joerg Hoh <jh...@adobe.com>
AuthorDate: Thu Jun 2 18:37:02 2022 +0200
add a bit more javadoc
---
.../apache/sling/testing/clients/exceptions/TestingIOException.java | 4 ++++
.../sling/testing/clients/exceptions/TestingSetupException.java | 4 ++++
.../sling/testing/clients/exceptions/TestingValidationException.java | 5 +++++
3 files changed, 13 insertions(+)
diff --git a/src/main/java/org/apache/sling/testing/clients/exceptions/TestingIOException.java b/src/main/java/org/apache/sling/testing/clients/exceptions/TestingIOException.java
index 7597ffc..6f7992e 100644
--- a/src/main/java/org/apache/sling/testing/clients/exceptions/TestingIOException.java
+++ b/src/main/java/org/apache/sling/testing/clients/exceptions/TestingIOException.java
@@ -22,6 +22,10 @@ import org.apache.http.client.methods.HttpUriRequest;
import org.apache.sling.testing.clients.ClientException;
import org.apache.sling.testing.clients.SlingHttpResponse;
+/**
+ * Use this exception to indicate any problems with networking (typically manifested as
+ * IOException).
+ */
public class TestingIOException extends ClientException {
public TestingIOException(String message) {
diff --git a/src/main/java/org/apache/sling/testing/clients/exceptions/TestingSetupException.java b/src/main/java/org/apache/sling/testing/clients/exceptions/TestingSetupException.java
index d5f929a..4346837 100644
--- a/src/main/java/org/apache/sling/testing/clients/exceptions/TestingSetupException.java
+++ b/src/main/java/org/apache/sling/testing/clients/exceptions/TestingSetupException.java
@@ -22,6 +22,10 @@ import org.apache.http.client.methods.HttpUriRequest;
import org.apache.sling.testing.clients.ClientException;
import org.apache.sling.testing.clients.SlingHttpResponse;
+/**
+ * Use this exception to signal problems in the test setup, e.g. incorrect or missing
+ * parameters.
+ */
public class TestingSetupException extends ClientException {
public TestingSetupException(String message) {
diff --git a/src/main/java/org/apache/sling/testing/clients/exceptions/TestingValidationException.java b/src/main/java/org/apache/sling/testing/clients/exceptions/TestingValidationException.java
index ce9e1dd..4a43763 100644
--- a/src/main/java/org/apache/sling/testing/clients/exceptions/TestingValidationException.java
+++ b/src/main/java/org/apache/sling/testing/clients/exceptions/TestingValidationException.java
@@ -22,6 +22,11 @@ import org.apache.http.client.methods.HttpUriRequest;
import org.apache.sling.testing.clients.ClientException;
import org.apache.sling.testing.clients.SlingHttpResponse;
+/**
+ * Use this exception to indicate any mismatch between expectations and the actual
+ * test result. This exception typically indicates "real" test failures.
+ *
+ */
public class TestingValidationException extends ClientException {
public TestingValidationException(String message) {