From dfb4af61e4180c6dd769e56b4f154c0c7650cfea Mon Sep 17 00:00:00 2001
From: Andrew Berezovskyi <andriib@kth.se>
Date: Tue, 1 Oct 2024 23:29:43 +0200
Subject: [PATCH] docs: update javadoc

---
 .../org/eclipse/lyo/client/query/OslcQueryResult.java  | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/client/oslc-client/src/main/java/org/eclipse/lyo/client/query/OslcQueryResult.java b/client/oslc-client/src/main/java/org/eclipse/lyo/client/query/OslcQueryResult.java
index a51dacd5..f899d82b 100644
--- a/client/oslc-client/src/main/java/org/eclipse/lyo/client/query/OslcQueryResult.java
+++ b/client/oslc-client/src/main/java/org/eclipse/lyo/client/query/OslcQueryResult.java
@@ -138,7 +138,7 @@ private synchronized void initializeRdf() {
             }
             if(infoResource == null) {
                 // TODO: also check for oslc:nextPage before giving up
-                throw new IllegalStateException("Multiple ResponseInfo objects found; neither matches the Query URI");
+                throw new IllegalStateException("Failed to find an appropriate ResponseInfo object");
             }
 
 			membersResource = rdfModel.getResource(query.getCapabilityUrl());
@@ -148,7 +148,8 @@ private synchronized void initializeRdf() {
     /**
      * Extracts a ResourceInfo resource if one and only one has the same prefix as the query URI.
      * @param responseInfos from OSLC Query results
-     * @return a ResourceInfo resource if one satisfies the conditions; null otherwise
+     * @return a ResourceInfo resource if one satisfies the conditions; null if none satisfy
+     * @throws IllegalStateException if multiple resources satisfy the same condition
      */
     private Resource tryFindPrefixedResponseInfoUri(List<Resource> responseInfos) {
         List<Resource> filteredObjects = responseInfos.stream().filter(ri -> ri.getURI().startsWith(query.getQueryUrl())).toList();
@@ -163,7 +164,8 @@ private Resource tryFindPrefixedResponseInfoUri(List<Resource> responseInfos) {
     /**
      * Extracts a ResourceInfo resource if one and only one has exactly the same URI as the query URI.
      * @param responseInfos from OSLC Query results
-     * @return a ResourceInfo resource if one satisfies the conditions; null otherwise
+     * @return a ResourceInfo resource if one satisfies the conditions; null if none satisfy
+     * @throws IllegalStateException if multiple resources satisfy the same condition
      */
     private Resource tryFindExactResponseInfoUri(List<Resource> responseInfos) {
         List<Resource> filteredObjects = responseInfos.stream().filter(ri -> ri.getURI().equals(query.getQueryUrl())).toList();
@@ -178,7 +180,7 @@ private Resource tryFindExactResponseInfoUri(List<Resource> responseInfos) {
     /**
      * Extracts a ResourceInfo resource if one and only one exists in the results.
      * @param responseInfos from OSLC Query results
-     * @return a ResourceInfo resource if one satisfies the conditions; null otherwise
+     * @return a ResourceInfo resource if one satisfies the conditions; null if none satisfy
      */
     private Resource tryFindOnlyResponseInfo(List<Resource> responseInfos) {
         if (responseInfos.size() == 1) {