You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by dk...@apache.org on 2023/03/01 19:34:43 UTC

[sling-org-apache-sling-resourcecollection] 01/01: SLING-11794 - Adding a new method to get the properties as an adapted type

This is an automated email from the ASF dual-hosted git repository.

dklco pushed a commit to branch SLING-11794
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-resourcecollection.git

commit 427cb0de0c3b2a30258139771aa5f0a5635bad32
Author: Dan Klco <kl...@adobe.com>
AuthorDate: Wed Mar 1 14:34:25 2023 -0500

    SLING-11794 - Adding a new method to get the properties as an adapted type
---
 .../resource/collection/ResourceCollection.java    | 12 +++-
 .../collection/impl/ResourceCollectionImpl.java    | 24 +++++---
 .../sling/resource/collection/package-info.java    |  2 +-
 .../impl/ResourceCollectionImplTest.java           | 70 +++++++++++++++++++++-
 4 files changed, 95 insertions(+), 13 deletions(-)

diff --git a/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java b/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
index de88eb0..00fd2b2 100755
--- a/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
+++ b/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
@@ -20,6 +20,7 @@ package org.apache.sling.resource.collection;
 
 import java.util.Iterator;
 import java.util.Map;
+import java.util.Optional;
 
 import org.apache.sling.api.resource.ModifiableValueMap;
 import org.apache.sling.api.resource.PersistenceException;
@@ -67,7 +68,16 @@ public interface ResourceCollection {
     /**
      * Returns additional properties for a particular resource in Collection entry.
      *
-     * @return properties of the Collection entry as <code>ModifiableValueMap</code>, returns null if entry found.
+     * @return properties of the Collection entry as the specified type, returns empty if no entry found or 
+     *  the entry cannot be adapted to the type
+     */
+    <T> Optional<T> getPropertiesAs(Resource resource, Class<T> type);
+
+    /**
+     * Returns additional properties for a particular resource in Collection entry.
+     *
+     * @return properties of the Collection entry as <code>ModifiableValueMap</code>, returns null if no entry found
+     *  or the entry cannot be adapted to a ModifiableValueMap
      */
     ModifiableValueMap getProperties(Resource resource);
 
diff --git a/src/main/java/org/apache/sling/resource/collection/impl/ResourceCollectionImpl.java b/src/main/java/org/apache/sling/resource/collection/impl/ResourceCollectionImpl.java
index 12cb05a..7a9c6af 100755
--- a/src/main/java/org/apache/sling/resource/collection/impl/ResourceCollectionImpl.java
+++ b/src/main/java/org/apache/sling/resource/collection/impl/ResourceCollectionImpl.java
@@ -25,6 +25,7 @@ import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.sling.api.SlingConstants;
@@ -293,19 +294,24 @@ public class ResourceCollectionImpl implements
 		vm.put(ResourceCollectionConstants.REFERENCES_PROP, order);
 	}
 
-	@Override
-    public ModifiableValueMap getProperties(Resource resource) {
-		Iterator<Resource> entries = membersResource.listChildren();
+    @Override
+    public <T> Optional<T> getPropertiesAs(Resource resource, Class<T> type) {
+        Iterator<Resource> entries = membersResource.listChildren();
         while (entries.hasNext()) {
-        	Resource entry = entries.next();
-        	String path = ResourceUtil.getValueMap(entry).get(
-        			ResourceCollectionConstants.REF_PROPERTY, "");
+            Resource entry = entries.next();
+            String path = ResourceUtil.getValueMap(entry).get(
+                    ResourceCollectionConstants.REF_PROPERTY, "");
 
             if (resource.getPath().equals(path)) {
-            	return entry.adaptTo(ModifiableValueMap.class);
+                return Optional.ofNullable(entry.adaptTo(type));
             }
         }
 
-        return null;
-	}
+        return Optional.empty();
+    }
+
+    @Override
+    public ModifiableValueMap getProperties(Resource resource) {
+        return getPropertiesAs(resource, ModifiableValueMap.class).orElse(null);
+    }
 }
diff --git a/src/main/java/org/apache/sling/resource/collection/package-info.java b/src/main/java/org/apache/sling/resource/collection/package-info.java
index bc6c9fd..232b52f 100644
--- a/src/main/java/org/apache/sling/resource/collection/package-info.java
+++ b/src/main/java/org/apache/sling/resource/collection/package-info.java
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-@org.osgi.annotation.versioning.Version("1.0.2")
+@org.osgi.annotation.versioning.Version("1.1.0")
 package org.apache.sling.resource.collection;
 
 
diff --git a/src/test/java/org/apache/sling/resource/collection/impl/ResourceCollectionImplTest.java b/src/test/java/org/apache/sling/resource/collection/impl/ResourceCollectionImplTest.java
index eb9624d..2ec0fe9 100755
--- a/src/test/java/org/apache/sling/resource/collection/impl/ResourceCollectionImplTest.java
+++ b/src/test/java/org/apache/sling/resource/collection/impl/ResourceCollectionImplTest.java
@@ -22,16 +22,17 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
-
-import junit.framework.Assert;
+import java.util.Optional;
 
 import org.apache.sling.api.SlingConstants;
+import org.apache.sling.api.resource.PersistenceException;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.resource.collection.ResourceCollection;
 import org.apache.sling.resource.collection.ResourceCollectionManager;
 import org.apache.sling.testing.resourceresolver.MockResourceResolverFactory;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -221,4 +222,69 @@ public class ResourceCollectionImplTest {
 
         Assert.assertEquals(0, numOfRes);
 	}
+
+    @Test
+    public void testCollectionPropertiesAs() throws PersistenceException {
+        final Map<String, Object> props = new HashMap<String, Object>();
+        props.put("creator", "slingdev");
+
+        final ResourceCollection collection = rcm.createCollection(resResolver.getResource("/"), "collection3");
+
+        final Resource resource = resResolver.create(resResolver.getResource("/"), "res1",
+                Collections.singletonMap(PROPERTY_RESOURCE_TYPE, (Object) "type"));
+        collection.add(resource, props);
+
+        final Resource collectionRes = resResolver.getResource("/collection3");
+        Assert.assertNotNull(collectionRes);
+
+        Assert.assertEquals(true, collection.contains(resource));
+
+        Optional<ValueMap> vm = collection.getPropertiesAs(resource, ValueMap.class);
+
+        Assert.assertNotNull(vm);
+        Assert.assertTrue(vm.isPresent());
+        Assert.assertEquals("slingdev", vm.get().get("creator", ""));
+    }
+
+    @Test
+    public void testCollectionPropertiesAs__emptyOnInvalidAdaptTo() throws PersistenceException {
+        final Map<String, Object> props = new HashMap<String, Object>();
+        props.put("creator", "slingdev");
+
+        final ResourceCollection collection = rcm.createCollection(resResolver.getResource("/"), "collection3");
+
+        final Resource resource = resResolver.create(resResolver.getResource("/"), "res1",
+                Collections.singletonMap(PROPERTY_RESOURCE_TYPE, (Object) "type"));
+        collection.add(resource, props);
+
+        final Resource collectionRes = resResolver.getResource("/collection3");
+        Assert.assertNotNull(collectionRes);
+
+        Assert.assertEquals(true, collection.contains(resource));
+
+        Optional<IllegalArgumentException> vm = collection.getPropertiesAs(resource, IllegalArgumentException.class);
+
+        Assert.assertNotNull(vm);
+        Assert.assertFalse(vm.isPresent());
+    }
+
+    @Test
+    public void testCollectionPropertiesAs__emptyOnInvalidResource() throws PersistenceException {
+
+        final ResourceCollection collection = rcm.createCollection(resResolver.getResource("/"), "collection3");
+
+        final Resource resource = resResolver.create(resResolver.getResource("/"), "res1",
+                Collections.singletonMap(PROPERTY_RESOURCE_TYPE, (Object) "type"));
+
+        final Resource collectionRes = resResolver.getResource("/collection3");
+        Assert.assertNotNull(collectionRes);
+
+        Assert.assertEquals(false, collection.contains(resource));
+
+        Optional<ValueMap> vm = collection.getPropertiesAs(resource, ValueMap.class);
+
+        Assert.assertNotNull(vm);
+        Assert.assertFalse(vm.isPresent());
+    }
+
 }
\ No newline at end of file