[sling-org-apache-sling-resourcemerger] 13/23: Refactoring - put pickers into separate package, align name of CRUD implementation

[ro...@apache.org]

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

rombert pushed a commit to annotated tag org.apache.sling.resourcemerger-1.2.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-resourcemerger.git

commit 290ce09875dbfcd0b6f7ee05173863b12dad8e15
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Sat Sep 13 15:38:56 2014 +0000

    Refactoring - put pickers into separate package, align name of CRUD implementation
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/resourcemerger@1624754 13f79535-47bb-0310-9956-ffa450edef68
---
 ...dResourceProvider.java => CRUDMergingResourceProvider.java} |  4 ++--
 .../resourcemerger/impl/MergingResourceProviderFactory.java    |  4 ++--
 .../MergingResourcePicker.java}                                | 10 ++++++----
 .../impl/{ => picker}/OverridingResourcePicker.java            |  2 +-
 .../apache/sling/resourcemerger/spi/MergedResourcePicker.java  |  6 ++++--
 .../sling/resourcemerger/impl/MergedResourceProviderTest.java  |  5 +++--
 .../resourcemerger/impl/OverridingResourceProviderTest.java    |  1 +
 7 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/src/main/java/org/apache/sling/resourcemerger/impl/CRUDMergedResourceProvider.java b/src/main/java/org/apache/sling/resourcemerger/impl/CRUDMergingResourceProvider.java
similarity index 98%
rename from src/main/java/org/apache/sling/resourcemerger/impl/CRUDMergedResourceProvider.java
rename to src/main/java/org/apache/sling/resourcemerger/impl/CRUDMergingResourceProvider.java
index 96a667b..6dcab25 100644
--- a/src/main/java/org/apache/sling/resourcemerger/impl/CRUDMergedResourceProvider.java
+++ b/src/main/java/org/apache/sling/resourcemerger/impl/CRUDMergingResourceProvider.java
@@ -33,11 +33,11 @@ import org.apache.sling.resourcemerger.spi.MergedResourcePicker;
 /**
  * This is a modifiable resource provider.
  */
-public class CRUDMergedResourceProvider
+public class CRUDMergingResourceProvider
     extends MergingResourceProvider
     implements ModifyingResourceProvider {
 
-    public CRUDMergedResourceProvider(final String mergeRootPath,
+    public CRUDMergingResourceProvider(final String mergeRootPath,
             final MergedResourcePicker picker) {
         super(mergeRootPath, picker, false);
     }
diff --git a/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProviderFactory.java b/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProviderFactory.java
index 3382fc7..72bbddf 100644
--- a/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProviderFactory.java
+++ b/src/main/java/org/apache/sling/resourcemerger/impl/MergingResourceProviderFactory.java
@@ -46,7 +46,7 @@ class MergingResourceProviderFactory implements ResourceProviderFactory {
         if ( this.readOnly ) {
             return new MergingResourceProvider(mergeRootPath, picker, this.readOnly);
         }
-        return new CRUDMergedResourceProvider(mergeRootPath, picker);
+        return new CRUDMergingResourceProvider(mergeRootPath, picker);
     }
 
     public ResourceProvider getAdministrativeResourceProvider(final Map<String, Object> authenticationInfo)
@@ -54,7 +54,7 @@ class MergingResourceProviderFactory implements ResourceProviderFactory {
         if ( this.readOnly ) {
             return new MergingResourceProvider(mergeRootPath, picker, this.readOnly);
         }
-        return new CRUDMergedResourceProvider(mergeRootPath, picker);
+        return new CRUDMergingResourceProvider(mergeRootPath, picker);
     }
 
 }
diff --git a/src/main/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderFactory.java b/src/main/java/org/apache/sling/resourcemerger/impl/picker/MergingResourcePicker.java
similarity index 92%
rename from src/main/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderFactory.java
rename to src/main/java/org/apache/sling/resourcemerger/impl/picker/MergingResourcePicker.java
index a8d33e6..aed4d94 100644
--- a/src/main/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderFactory.java
+++ b/src/main/java/org/apache/sling/resourcemerger/impl/picker/MergingResourcePicker.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.sling.resourcemerger.impl;
+package org.apache.sling.resourcemerger.impl.picker;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -34,14 +34,16 @@ import org.apache.sling.api.resource.ResourceProvider;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.commons.osgi.PropertiesUtil;
 import org.apache.sling.resourcemerger.api.ResourceMergerService;
+import org.apache.sling.resourcemerger.impl.MergedResourceConstants;
 import org.apache.sling.resourcemerger.spi.MergedResourcePicker;
 
-@Component(label = "Apache Sling Merged Resource Provider Factory",
+@Component(name="org.apache.sling.resourcemerger.impl.MergedResourceProviderFactory",
+           label = "Apache Sling Merged Resource Provider Factory",
            description = "This resource provider delivers merged resources based on the search paths.",
            metatype=true)
 @Service(value={MergedResourcePicker.class, ResourceMergerService.class})
 @Properties({
-    @Property(name=MergedResourcePicker.MERGE_ROOT, value=MergedResourceProviderFactory.DEFAULT_ROOT,
+    @Property(name=MergedResourcePicker.MERGE_ROOT, value=MergingResourcePicker.DEFAULT_ROOT,
             label="Root",
             description="The mount point of merged resources"),
     @Property(name=MergedResourcePicker.READ_ONLY, boolValue=true,
@@ -53,7 +55,7 @@ import org.apache.sling.resourcemerger.spi.MergedResourcePicker;
  * The <code>MergedResourceProviderFactory</code> creates merged resource
  * providers and implements the <code>ResourceMergerService</code>.
  */
-public class MergedResourceProviderFactory implements MergedResourcePicker, ResourceMergerService {
+public class MergingResourcePicker implements MergedResourcePicker, ResourceMergerService {
 
     public static final String DEFAULT_ROOT = "/mnt/overlay";
 
diff --git a/src/main/java/org/apache/sling/resourcemerger/impl/OverridingResourcePicker.java b/src/main/java/org/apache/sling/resourcemerger/impl/picker/OverridingResourcePicker.java
similarity index 98%
rename from src/main/java/org/apache/sling/resourcemerger/impl/OverridingResourcePicker.java
rename to src/main/java/org/apache/sling/resourcemerger/impl/picker/OverridingResourcePicker.java
index eab462f..62c3cca 100644
--- a/src/main/java/org/apache/sling/resourcemerger/impl/OverridingResourcePicker.java
+++ b/src/main/java/org/apache/sling/resourcemerger/impl/picker/OverridingResourcePicker.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.sling.resourcemerger.impl;
+package org.apache.sling.resourcemerger.impl.picker;
 
 import java.util.ArrayList;
 import java.util.Collections;
diff --git a/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java b/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java
index f158470..871f62e 100644
--- a/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java
+++ b/src/main/java/org/apache/sling/resourcemerger/spi/MergedResourcePicker.java
@@ -21,13 +21,14 @@ package org.apache.sling.resourcemerger.spi;
 import java.util.Iterator;
 
 import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceProviderFactory;
 import org.apache.sling.api.resource.ResourceResolver;
 
 import aQute.bnd.annotation.ConsumerType;
 
 /**
  * Service interface which can be implemented to define an algorithm used to pick
- * resources to be merged. For each picker service, a separate ResourceProviderFactory
+ * resources to be merged. For each picker service, a separate {@link ResourceProviderFactory}
  * will be exposed at the MERGE_ROOT of the picker.
  */
 @ConsumerType
@@ -36,7 +37,8 @@ public interface MergedResourcePicker {
     /**
      * Service property name identifying the root path for the merged resources.
      * By convention, starts, with /mnt, although this is by no means required.
-     * The value of this service property must not end in a slash.
+     * The value of this service property must be of type String and must not end
+     * in a slash.
      */
     String MERGE_ROOT = "merge.root";
 
diff --git a/src/test/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderTest.java b/src/test/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderTest.java
index 30fe6e4..8a36995 100644
--- a/src/test/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderTest.java
+++ b/src/test/java/org/apache/sling/resourcemerger/impl/MergedResourceProviderTest.java
@@ -35,6 +35,7 @@ import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ResourceResolverFactory;
 import org.apache.sling.api.resource.ResourceUtil;
 import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.resourcemerger.impl.picker.MergingResourcePicker;
 import org.apache.sling.testing.resourceresolver.MockHelper;
 import org.apache.sling.testing.resourceresolver.MockResourceResolverFactory;
 import org.apache.sling.testing.resourceresolver.MockResourceResolverFactoryOptions;
@@ -45,7 +46,7 @@ public class MergedResourceProviderTest {
 
     private ResourceResolver resolver;
 
-    private CRUDMergedResourceProvider provider;
+    private CRUDMergingResourceProvider provider;
 
     @Before public void setup() throws Exception {
         final MockResourceResolverFactoryOptions options = new MockResourceResolverFactoryOptions();
@@ -77,7 +78,7 @@ public class MergedResourceProviderTest {
                                             .resource(".Z")
                                         .commit();
 
-        this.provider = new CRUDMergedResourceProvider("/merged", new MergedResourceProviderFactory());
+        this.provider = new CRUDMergingResourceProvider("/merged", new MergingResourcePicker());
     }
 
     @Test public void testHideChildren() {
diff --git a/src/test/java/org/apache/sling/resourcemerger/impl/OverridingResourceProviderTest.java b/src/test/java/org/apache/sling/resourcemerger/impl/OverridingResourceProviderTest.java
index 814338e..064f2a0 100644
--- a/src/test/java/org/apache/sling/resourcemerger/impl/OverridingResourceProviderTest.java
+++ b/src/test/java/org/apache/sling/resourcemerger/impl/OverridingResourceProviderTest.java
@@ -32,6 +32,7 @@ import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ResourceResolverFactory;
 import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.resourcemerger.impl.picker.OverridingResourcePicker;
 import org.apache.sling.testing.resourceresolver.MockHelper;
 import org.apache.sling.testing.resourceresolver.MockResourceResolverFactory;
 import org.apache.sling.testing.resourceresolver.MockResourceResolverFactoryOptions;

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.