From 3efbe1eaae5bbb04f162f8eacfe5c877d69bfa2d Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Sat, 26 Apr 2025 17:46:36 +0200 Subject: [PATCH] Update response handling logic in ResponseValidator Refined the condition for exception handling based on 'emptyResultThrowsException' to clarify when exceptions are triggered versus returning empty results. Updated Javadoc output files to reflect the latest documentation changes. --- docs/apidocs/allclasses-index.html | 4 +- docs/apidocs/allpackages-index.html | 4 +- .../codes/thischwa/cf/CfDnsClient.html | 87 +++++++++++++++---- docs/apidocs/codes/thischwa/cf/CfRequest.html | 4 +- .../thischwa/cf/CloudflareApiException.html | 4 +- .../cf/CloudflareNotFoundException.html | 4 +- .../thischwa/cf/class-use/CfDnsClient.html | 4 +- .../thischwa/cf/class-use/CfRequest.html | 4 +- .../cf/class-use/CloudflareApiException.html | 4 +- .../CloudflareNotFoundException.html | 4 +- .../thischwa/cf/model/AbstractEntity.html | 4 +- .../cf/model/AbstractMultipleResponse.html | 4 +- .../thischwa/cf/model/AbstractResponse.html | 4 +- .../cf/model/AbstractSingleResponse.html | 4 +- .../thischwa/cf/model/PagingRequest.html | 4 +- .../codes/thischwa/cf/model/RecordEntity.html | 4 +- .../cf/model/RecordMultipleResponse.html | 4 +- .../cf/model/RecordSingleResponse.html | 4 +- .../codes/thischwa/cf/model/RecordType.html | 4 +- .../thischwa/cf/model/ResponseEntity.html | 4 +- .../thischwa/cf/model/ResponseResultInfo.html | 4 +- .../codes/thischwa/cf/model/ResultInfo.html | 4 +- .../codes/thischwa/cf/model/ZoneEntity.html | 4 +- .../cf/model/ZoneMultipleResponse.html | 4 +- .../cf/model/class-use/AbstractEntity.html | 4 +- .../class-use/AbstractMultipleResponse.html | 4 +- .../cf/model/class-use/AbstractResponse.html | 4 +- .../class-use/AbstractSingleResponse.html | 4 +- .../cf/model/class-use/PagingRequest.html | 4 +- .../cf/model/class-use/RecordEntity.html | 4 +- .../class-use/RecordMultipleResponse.html | 4 +- .../model/class-use/RecordSingleResponse.html | 4 +- .../cf/model/class-use/RecordType.html | 4 +- .../cf/model/class-use/ResponseEntity.html | 4 +- .../model/class-use/ResponseResultInfo.html | 4 +- .../cf/model/class-use/ResultInfo.html | 4 +- .../cf/model/class-use/ZoneEntity.html | 4 +- .../model/class-use/ZoneMultipleResponse.html | 4 +- .../thischwa/cf/model/package-summary.html | 4 +- .../codes/thischwa/cf/model/package-tree.html | 4 +- .../codes/thischwa/cf/model/package-use.html | 4 +- .../codes/thischwa/cf/package-summary.html | 4 +- .../codes/thischwa/cf/package-tree.html | 4 +- .../codes/thischwa/cf/package-use.html | 4 +- docs/apidocs/help-doc.html | 4 +- docs/apidocs/index-all.html | 17 ++-- docs/apidocs/index.html | 4 +- docs/apidocs/member-search-index.js | 5 ++ docs/apidocs/overview-summary.html | 4 +- docs/apidocs/overview-tree.html | 4 +- docs/apidocs/search.html | 4 +- docs/apidocs/serialized-form.html | 4 +- .../java/codes/thischwa/cf/CfDnsClient.java | 16 ++-- .../codes/thischwa/cf/ResponseValidator.java | 4 +- 54 files changed, 195 insertions(+), 130 deletions(-) diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html index fb70a25..affa7fc 100644 --- a/docs/apidocs/allclasses-index.html +++ b/docs/apidocs/allclasses-index.html @@ -1,11 +1,11 @@ - + Alle Klassen und Schnittstellen (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/allpackages-index.html b/docs/apidocs/allpackages-index.html index 6f6af4f..44e1a97 100644 --- a/docs/apidocs/allpackages-index.html +++ b/docs/apidocs/allpackages-index.html @@ -1,11 +1,11 @@ - + Alle Packages (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html index bde75ca..97ded32 100644 --- a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html +++ b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html @@ -1,11 +1,11 @@ - + CfDnsClient (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -96,6 +96,7 @@ loadScripts(document, 'script');
CfDnsClient is a client interface to interact with Cloudflare DNS service. It allows managing DNS records and zones within the Cloudflare system, including creating, updating, retrieving, and deleting DNS records. +

Example:


  // Create a new CfDnsClient instance
@@ -123,24 +124,48 @@ loadScripts(document, 'script');
 
Konstruktor
Beschreibung
-
CfDnsClient(boolean emptyResultThrowsException, - String baseUrl, +
CfDnsClient + + (boolean emptyResultThrowsException, String authEmail, String authKey)
-
Constructs a new instance of CfDnsClient, which facilitates interactions with the - Cloudflare DNS API.
+
Constructs a new instance of CfDnsClient.
-
CfDnsClient(String authEmail, +
CfDnsClient + + (boolean emptyResultThrowsException, + String baseUrl, + String authEmail, String authKey)
-
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
Constructs a new instance of CfDnsClient.
-
CfDnsClient(String baseUrl, - String authEmail, +
CfDnsClient + + (String authEmail, String authKey)
-
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
Constructs a new instance of CfDnsClient.
+
+
CfDnsClient + + (String baseUrl, + String authEmail, + String authKey)
+
+
Constructs a new instance of CfDnsClient.
@@ -331,7 +356,7 @@ loadScripts(document, 'script');

CfDnsClient

public CfDnsClient(String authEmail, String authKey)
-
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
Constructs a new instance of CfDnsClient.
Parameter:
authEmail - The email address associated with the Cloudflare account, used for @@ -349,7 +374,7 @@ loadScripts(document, 'script');
public CfDnsClient(String baseUrl, String authEmail, String authKey)
-
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
Constructs a new instance of CfDnsClient.
Parameter:
baseUrl - The base URL of the Cloudflare API to be used for requests.
@@ -361,6 +386,32 @@ loadScripts(document, 'script');
+ +
  • +
    +

    CfDnsClient

    +
    public CfDnsClient + + (boolean emptyResultThrowsException, + String authEmail, + String authKey)
    +
    Constructs a new instance of CfDnsClient.
    +
    +
    Parameter:
    +
    emptyResultThrowsException - A boolean value indicating whether an exception should be + thrown when the result is empty, it's valid for 'list + requests' only. Default is true. +
    +
    authEmail - The email address associated with the Cloudflare account, + used for authentication. +
    +
    authKey - The API key of the Cloudflare account, used as part of the + authentication process. +
    +
    +
  • @@ -369,13 +420,13 @@ loadScripts(document, 'script'); String baseUrl, String authEmail, String authKey)
  • -
    Constructs a new instance of CfDnsClient, which facilitates interactions with the - Cloudflare DNS API.
    +
    Constructs a new instance of CfDnsClient.
    Parameter:
    -
    emptyResultThrowsException - Specifies if an exception should be thrown when the API - response is empty. Default is true. -
    +
    emptyResultThrowsException - A boolean value indicating whether an exception should be + thrown when the result is empty, it's valid for 'list + requests' only. Default is true. +
    baseUrl - The base URL for the Cloudflare API endpoint.
    authEmail - The email associated with the Cloudflare account for authentication. diff --git a/docs/apidocs/codes/thischwa/cf/CfRequest.html b/docs/apidocs/codes/thischwa/cf/CfRequest.html index 28f3bec..5f2b191 100644 --- a/docs/apidocs/codes/thischwa/cf/CfRequest.html +++ b/docs/apidocs/codes/thischwa/cf/CfRequest.html @@ -1,11 +1,11 @@ - + CfRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html index 612cfa3..776d0ca 100644 --- a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html +++ b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html @@ -1,11 +1,11 @@ - + CloudflareApiException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html index d4a5108..b9492da 100644 --- a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html +++ b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html @@ -1,11 +1,11 @@ - + CloudflareNotFoundException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html index 3d027a7..7c777e6 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CfDnsClient (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html index 935c5c2..c3e373e 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Enum-Klasse codes.thischwa.cf.CfRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html index ed7154b..f7690d0 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CloudflareApiException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html index 0b299f7..c5eb949 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CloudflareNotFoundException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html index d7a6b2a..b2a91b8 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html @@ -1,11 +1,11 @@ - + AbstractEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html index c7b4c9c..070f065 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html @@ -1,11 +1,11 @@ - + AbstractMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html index 5b7565c..05683a1 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html @@ -1,11 +1,11 @@ - + AbstractResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html index 8a9f1df..e4c366d 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html @@ -1,11 +1,11 @@ - + AbstractSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html index 4625073..a2b2fe6 100644 --- a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html +++ b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html @@ -1,11 +1,11 @@ - + PagingRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html index 3f4ad8c..930f13d 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html @@ -1,11 +1,11 @@ - + RecordEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html index 7e1f057..2ef02ea 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html @@ -1,11 +1,11 @@ - + RecordMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html index 97d052c..03d7800 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html @@ -1,11 +1,11 @@ - + RecordSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/RecordType.html index ae1cb62..27f678c 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordType.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordType.html @@ -1,11 +1,11 @@ - + RecordType (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html index dc6d2ba..3677c25 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html @@ -1,11 +1,11 @@ - + ResponseEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html index 749bce4..56da7d9 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html @@ -1,11 +1,11 @@ - + ResponseResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html index 3378740..cf0e0c6 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html @@ -1,11 +1,11 @@ - + ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html index d9b462b..a2d2f1b 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html @@ -1,11 +1,11 @@ - + ZoneEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html index 1372412..7ddb7b6 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html @@ -1,11 +1,11 @@ - + ZoneMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html index c5a25c1..c30162b 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html index 443a000..4093226 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html index 98710ba..8f5cc8f 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html index 669c68d..0fa5dca 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html index 73d4056..b49eb60 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.PagingRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html index d412eec..f126437 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html index 27eba69..3450cdc 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html index 97bea97..9a7c97d 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html index 8e5ca72..63b1aee 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Enum-Klasse codes.thischwa.cf.model.RecordType (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html index 845d5ff..644114e 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Schnittstelle codes.thischwa.cf.model.ResponseEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html index b6330bd..b53a3cb 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ResponseResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html index 9f7d4ec..3ded938 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html index edd3208..ff7a1a3 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html index 69eebff..82b882c 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-summary.html b/docs/apidocs/codes/thischwa/cf/model/package-summary.html index 6942444..53fe18f 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-summary.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-summary.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf.model (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-tree.html b/docs/apidocs/codes/thischwa/cf/model/package-tree.html index 25b62fe..e07e826 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-tree.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-tree.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf.model Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-use.html b/docs/apidocs/codes/thischwa/cf/model/package-use.html index c40ebbc..2c1736e 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-use.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-use.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Package codes.thischwa.cf.model (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/package-summary.html b/docs/apidocs/codes/thischwa/cf/package-summary.html index 62a1658..709e7d7 100644 --- a/docs/apidocs/codes/thischwa/cf/package-summary.html +++ b/docs/apidocs/codes/thischwa/cf/package-summary.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/package-tree.html b/docs/apidocs/codes/thischwa/cf/package-tree.html index bfc84a5..c8f380f 100644 --- a/docs/apidocs/codes/thischwa/cf/package-tree.html +++ b/docs/apidocs/codes/thischwa/cf/package-tree.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/package-use.html b/docs/apidocs/codes/thischwa/cf/package-use.html index b396616..86b5486 100644 --- a/docs/apidocs/codes/thischwa/cf/package-use.html +++ b/docs/apidocs/codes/thischwa/cf/package-use.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Package codes.thischwa.cf (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html index f5ede8b..46b411d 100644 --- a/docs/apidocs/help-doc.html +++ b/docs/apidocs/help-doc.html @@ -1,11 +1,11 @@ - + API-Hilfe (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html index c1f045d..b05a0fd 100644 --- a/docs/apidocs/index-all.html +++ b/docs/apidocs/index-all.html @@ -1,11 +1,11 @@ - + Index (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -110,19 +110,24 @@ loadScripts(document, 'script');
    CfDnsClient - Klasse in codes.thischwa.cf
    CfDnsClient is a client interface to interact with Cloudflare DNS service.
    +
    +
    CfDnsClient(boolean, String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient
    +
    +
    Constructs a new instance of CfDnsClient.
    CfDnsClient(boolean, String, String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient
    -
    Constructs a new instance of CfDnsClient, which facilitates interactions with the - Cloudflare DNS API.
    +
    Constructs a new instance of CfDnsClient.
    CfDnsClient(String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient
    -
    Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
    +
    Constructs a new instance of CfDnsClient.
    CfDnsClient(String, String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient
    -
    Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
    +
    Constructs a new instance of CfDnsClient.
    CfRequest - Enum-Klasse in codes.thischwa.cf
    diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html index e6842d4..283ae07 100644 --- a/docs/apidocs/index.html +++ b/docs/apidocs/index.html @@ -1,11 +1,11 @@ - + Überblick (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/member-search-index.js b/docs/apidocs/member-search-index.js index ec299c7..5083172 100644 --- a/docs/apidocs/member-search-index.js +++ b/docs/apidocs/member-search-index.js @@ -31,6 +31,11 @@ memberSearchIndex = [{"p": "codes.thischwa.cf.model", "c": "RecordType", "l": "A "p": "codes.thischwa.cf.model", "c": "RecordType", "l": "CERT" +}, { + "p": "codes.thischwa.cf", + "c": "CfDnsClient", + "l": "CfDnsClient(boolean, String, String)", + "u": "%3Cinit%3E(boolean,java.lang.String,java.lang.String)" }, { "p": "codes.thischwa.cf", "c": "CfDnsClient", diff --git a/docs/apidocs/overview-summary.html b/docs/apidocs/overview-summary.html index a8ec09f..57de373 100644 --- a/docs/apidocs/overview-summary.html +++ b/docs/apidocs/overview-summary.html @@ -1,11 +1,11 @@ - + CloudflareDNS-java 0.2.0-SNAPSHOT API - + diff --git a/docs/apidocs/overview-tree.html b/docs/apidocs/overview-tree.html index 3610522..a7a0313 100644 --- a/docs/apidocs/overview-tree.html +++ b/docs/apidocs/overview-tree.html @@ -1,11 +1,11 @@ - + Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/search.html b/docs/apidocs/search.html index ea06e84..b441c74 100644 --- a/docs/apidocs/search.html +++ b/docs/apidocs/search.html @@ -1,11 +1,11 @@ - + Suchen (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/serialized-form.html b/docs/apidocs/serialized-form.html index dfd550c..d56a233 100644 --- a/docs/apidocs/serialized-form.html +++ b/docs/apidocs/serialized-form.html @@ -1,11 +1,11 @@ - + Serialisierte Form (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/src/main/java/codes/thischwa/cf/CfDnsClient.java b/src/main/java/codes/thischwa/cf/CfDnsClient.java index 4a1987f..8da39f5 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClient.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClient.java @@ -69,10 +69,13 @@ public class CfDnsClient extends CfBasicHttpClient { /** * Constructs a new instance of {@code CfDnsClient}. * - * @param emptyResultThrowsException a boolean value indicating whether an exception should be - * thrown when the result is empty - * @param authEmail the authentication email required for API access - * @param authKey the authentication key required for API access + * @param emptyResultThrowsException A boolean value indicating whether an exception should be + * thrown when the result is empty, it's valid for 'list + * requests' only. Default is true. + * @param authEmail The email address associated with the Cloudflare account, + * used for authentication. + * @param authKey The API key of the Cloudflare account, used as part of the + * authentication process. */ public CfDnsClient(boolean emptyResultThrowsException, String authEmail, String authKey) { this(emptyResultThrowsException, DEFAULT_BASEURL, authEmail, authKey); @@ -81,8 +84,9 @@ public class CfDnsClient extends CfBasicHttpClient { /** * Constructs a new instance of {@code CfDnsClient}. * - * @param emptyResultThrowsException Specifies if an exception should be thrown when the API - * response is empty. Default is true. + * @param emptyResultThrowsException A boolean value indicating whether an exception should be + * thrown when the result is empty, it's valid for 'list + * requests' only. Default is true. * @param baseUrl The base URL for the Cloudflare API endpoint. * @param authEmail The email associated with the Cloudflare account for * authentication. diff --git a/src/main/java/codes/thischwa/cf/ResponseValidator.java b/src/main/java/codes/thischwa/cf/ResponseValidator.java index dbb6b23..7c39341 100644 --- a/src/main/java/codes/thischwa/cf/ResponseValidator.java +++ b/src/main/java/codes/thischwa/cf/ResponseValidator.java @@ -15,8 +15,8 @@ import java.util.stream.Collectors; * metadata. If the response indicates failure, an exception is thrown with descriptive error * messages. *
  • If a {@link RecordMultipleResponse} is used, it validates the number of results in the API - * response payload to detect unexpected counts. Depending on the configuration, - * discrepancies in the result count or an empty result may trigger exceptions. + * response payload to detect unexpected counts. Depending on the parameter + * 'emptyResultThrowsException', an exception will be triggered or an empty result will be returned. * */ class ResponseValidator {