You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/11/07 09:18:48 UTC
[sling-org-apache-sling-caconfig-api] 02/24: SLING-5886 : Refactor
packages and update javadocs
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to annotated tag org.apache.sling.caconfig.api-1.0.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-caconfig-api.git
commit 77b18cfedcedfc147fb52162fadb29a9dd15f56e
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Fri Jul 29 12:31:34 2016 +0000
SLING-5886 : Refactor packages and update javadocs
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/context-aware-config/api@1754505 13f79535-47bb-0310-9956-ffa450edef68
---
.../{ => contextaware}/config/ConfigurationBuilder.java | 13 +++++++++----
.../{ => contextaware}/config/ConfigurationResolver.java | 7 ++++++-
.../sling/{ => contextaware}/config/package-info.java | 2 +-
.../config/spi/ConfigurationMetadataProvider.java | 4 ++--
.../config/spi/ConfigurationOverrideProvider.java | 2 +-
.../config/spi/ConfigurationPersistenceProvider.java | 2 +-
.../{ => contextaware}/config/spi/ContextPathStrategy.java | 2 +-
.../config/spi/metadata/AbstractConfigurationPart.java | 2 +-
.../config/spi/metadata/ConfigurationMetadata.java | 2 +-
.../config/spi/metadata/ConfigurationPart.java | 2 +-
.../config/spi/metadata/PropertyMetadata.java | 2 +-
.../config/spi/metadata/package-info.java | 2 +-
.../sling/{ => contextaware}/config/spi/package-info.java | 2 +-
.../resource/ConfigurationResourceResolver.java | 2 +-
.../{config => contextaware}/resource/package-info.java | 2 +-
.../config/spi/metadata/ConfigurationMetadataTest.java | 4 +++-
.../config/spi/metadata/PropertyMetadataTest.java | 3 ++-
17 files changed, 34 insertions(+), 21 deletions(-)
diff --git a/src/main/java/org/apache/sling/config/ConfigurationBuilder.java b/src/main/java/org/apache/sling/contextaware/config/ConfigurationBuilder.java
similarity index 83%
rename from src/main/java/org/apache/sling/config/ConfigurationBuilder.java
rename to src/main/java/org/apache/sling/contextaware/config/ConfigurationBuilder.java
index acf44c6..2a03f8d 100644
--- a/src/main/java/org/apache/sling/config/ConfigurationBuilder.java
+++ b/src/main/java/org/apache/sling/contextaware/config/ConfigurationBuilder.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config;
+package org.apache.sling.contextaware.config;
import java.util.Collection;
@@ -29,14 +29,19 @@ import org.osgi.annotation.versioning.ProviderType;
*/
@ProviderType
public interface ConfigurationBuilder {
-
+
/**
- * Define configuration name. Optional when using annotation class, mandatory when getting configuration as value map.
+ * Define configuration name. This parameter is optional, it defaults to the class
+ * name of the argument provided either to {@link #as(Class)} or {@link #asCollection(Class)}.
+ *
+ * TODO - what happens if an invalid name is provided? I assume the same as if no
+ * configuration resource exists.
+ *
* @param configName Relative path
* @return Configuration builder
*/
@Nonnull ConfigurationBuilder name(@Nonnull String configName);
-
+
/**
* Get configuration as singleton and its properties mapped to the given annotation class.
* @param clazz Annotation class or {@link org.apache.sling.api.resource.ValueMap}
diff --git a/src/main/java/org/apache/sling/config/ConfigurationResolver.java b/src/main/java/org/apache/sling/contextaware/config/ConfigurationResolver.java
similarity index 80%
rename from src/main/java/org/apache/sling/config/ConfigurationResolver.java
rename to src/main/java/org/apache/sling/contextaware/config/ConfigurationResolver.java
index b3a4285..a0434f8 100644
--- a/src/main/java/org/apache/sling/config/ConfigurationResolver.java
+++ b/src/main/java/org/apache/sling/contextaware/config/ConfigurationResolver.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config;
+package org.apache.sling.contextaware.config;
import javax.annotation.Nonnull;
@@ -27,6 +27,11 @@ import org.osgi.annotation.versioning.ProviderType;
* Getting context-specific configurations for a given resource context.
* Context-specific configuration may be different for different parts of the resource
* hierarchy, and configuration parameter inheritance may take place.
+ *
+ * This service builds on top of the {@link org.apache.sling.contextaware.resource.ConfigurationResourceResolver}
+ * and uses that service to resolve configuration resources. These resources
+ * can then be converted into application specific configuration objects
+ * using the {@link ConfigurationBuilder}.
*/
@ProviderType
public interface ConfigurationResolver {
diff --git a/src/main/java/org/apache/sling/config/package-info.java b/src/main/java/org/apache/sling/contextaware/config/package-info.java
similarity index 95%
rename from src/main/java/org/apache/sling/config/package-info.java
rename to src/main/java/org/apache/sling/contextaware/config/package-info.java
index e4bc375..ccfe13b 100644
--- a/src/main/java/org/apache/sling/config/package-info.java
+++ b/src/main/java/org/apache/sling/contextaware/config/package-info.java
@@ -20,4 +20,4 @@
* API for accessing context-specific configuration.
*/
@org.osgi.annotation.versioning.Version("1.0.0")
-package org.apache.sling.config;
+package org.apache.sling.contextaware.config;
diff --git a/src/main/java/org/apache/sling/config/spi/ConfigurationMetadataProvider.java b/src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationMetadataProvider.java
similarity index 90%
rename from src/main/java/org/apache/sling/config/spi/ConfigurationMetadataProvider.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationMetadataProvider.java
index c7e83f9..a260aca 100644
--- a/src/main/java/org/apache/sling/config/spi/ConfigurationMetadataProvider.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationMetadataProvider.java
@@ -16,13 +16,13 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi;
+package org.apache.sling.contextaware.config.spi;
import java.util.Collection;
import javax.annotation.Nonnull;
-import org.apache.sling.config.spi.metadata.ConfigurationMetadata;
+import org.apache.sling.contextaware.config.spi.metadata.ConfigurationMetadata;
import org.osgi.annotation.versioning.ConsumerType;
/**
diff --git a/src/main/java/org/apache/sling/config/spi/ConfigurationOverrideProvider.java b/src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationOverrideProvider.java
similarity index 98%
rename from src/main/java/org/apache/sling/config/spi/ConfigurationOverrideProvider.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationOverrideProvider.java
index 56b2d50..acd4d66 100644
--- a/src/main/java/org/apache/sling/config/spi/ConfigurationOverrideProvider.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationOverrideProvider.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi;
+package org.apache.sling.contextaware.config.spi;
import java.util.Map;
diff --git a/src/main/java/org/apache/sling/config/spi/ConfigurationPersistenceProvider.java b/src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationPersistenceProvider.java
similarity index 98%
rename from src/main/java/org/apache/sling/config/spi/ConfigurationPersistenceProvider.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationPersistenceProvider.java
index eee2245..e62b520 100644
--- a/src/main/java/org/apache/sling/config/spi/ConfigurationPersistenceProvider.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/ConfigurationPersistenceProvider.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi;
+package org.apache.sling.contextaware.config.spi;
import java.util.Map;
diff --git a/src/main/java/org/apache/sling/config/spi/ContextPathStrategy.java b/src/main/java/org/apache/sling/contextaware/config/spi/ContextPathStrategy.java
similarity index 96%
rename from src/main/java/org/apache/sling/config/spi/ContextPathStrategy.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/ContextPathStrategy.java
index 7d6b629..6935013 100644
--- a/src/main/java/org/apache/sling/config/spi/ContextPathStrategy.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/ContextPathStrategy.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi;
+package org.apache.sling.contextaware.config.spi;
import java.util.Collection;
diff --git a/src/main/java/org/apache/sling/config/spi/metadata/AbstractConfigurationPart.java b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/AbstractConfigurationPart.java
similarity index 97%
rename from src/main/java/org/apache/sling/config/spi/metadata/AbstractConfigurationPart.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/metadata/AbstractConfigurationPart.java
index b79d8b5..2b7fa39 100644
--- a/src/main/java/org/apache/sling/config/spi/metadata/AbstractConfigurationPart.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/AbstractConfigurationPart.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
import java.util.HashMap;
diff --git a/src/main/java/org/apache/sling/config/spi/metadata/ConfigurationMetadata.java b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationMetadata.java
similarity index 96%
rename from src/main/java/org/apache/sling/config/spi/metadata/ConfigurationMetadata.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationMetadata.java
index e43cecc..91a7480 100644
--- a/src/main/java/org/apache/sling/config/spi/metadata/ConfigurationMetadata.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationMetadata.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
import java.util.ArrayList;
import java.util.Collection;
diff --git a/src/main/java/org/apache/sling/config/spi/metadata/ConfigurationPart.java b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationPart.java
similarity index 95%
rename from src/main/java/org/apache/sling/config/spi/metadata/ConfigurationPart.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationPart.java
index 1a1590c..23be0c5 100644
--- a/src/main/java/org/apache/sling/config/spi/metadata/ConfigurationPart.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationPart.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
import java.util.regex.Pattern;
diff --git a/src/main/java/org/apache/sling/config/spi/metadata/PropertyMetadata.java b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/PropertyMetadata.java
similarity index 97%
rename from src/main/java/org/apache/sling/config/spi/metadata/PropertyMetadata.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/metadata/PropertyMetadata.java
index 2b4e1a6..e6ed34d 100644
--- a/src/main/java/org/apache/sling/config/spi/metadata/PropertyMetadata.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/PropertyMetadata.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
import javax.annotation.Nonnull;
diff --git a/src/main/java/org/apache/sling/config/spi/metadata/package-info.java b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/package-info.java
similarity index 94%
rename from src/main/java/org/apache/sling/config/spi/metadata/package-info.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/metadata/package-info.java
index f8b578b..0372745 100644
--- a/src/main/java/org/apache/sling/config/spi/metadata/package-info.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/metadata/package-info.java
@@ -20,4 +20,4 @@
* Defining configuration and parameter metadata for the SPI.
*/
@org.osgi.annotation.versioning.Version("1.0.0")
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
diff --git a/src/main/java/org/apache/sling/config/spi/package-info.java b/src/main/java/org/apache/sling/contextaware/config/spi/package-info.java
similarity index 95%
rename from src/main/java/org/apache/sling/config/spi/package-info.java
rename to src/main/java/org/apache/sling/contextaware/config/spi/package-info.java
index 3b35911..76033c3 100644
--- a/src/main/java/org/apache/sling/config/spi/package-info.java
+++ b/src/main/java/org/apache/sling/contextaware/config/spi/package-info.java
@@ -20,4 +20,4 @@
* SPI for applications hooking into the configuration infrastructure for parameterizing and customizing.
*/
@org.osgi.annotation.versioning.Version("1.0.0")
-package org.apache.sling.config.spi;
+package org.apache.sling.contextaware.config.spi;
diff --git a/src/main/java/org/apache/sling/config/resource/ConfigurationResourceResolver.java b/src/main/java/org/apache/sling/contextaware/resource/ConfigurationResourceResolver.java
similarity index 98%
rename from src/main/java/org/apache/sling/config/resource/ConfigurationResourceResolver.java
rename to src/main/java/org/apache/sling/contextaware/resource/ConfigurationResourceResolver.java
index 4fa6baf..e8f85d3 100644
--- a/src/main/java/org/apache/sling/config/resource/ConfigurationResourceResolver.java
+++ b/src/main/java/org/apache/sling/contextaware/resource/ConfigurationResourceResolver.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.resource;
+package org.apache.sling.contextaware.resource;
import java.util.Collection;
diff --git a/src/main/java/org/apache/sling/config/resource/package-info.java b/src/main/java/org/apache/sling/contextaware/resource/package-info.java
similarity index 95%
rename from src/main/java/org/apache/sling/config/resource/package-info.java
rename to src/main/java/org/apache/sling/contextaware/resource/package-info.java
index f602d02..4344ba3 100644
--- a/src/main/java/org/apache/sling/config/resource/package-info.java
+++ b/src/main/java/org/apache/sling/contextaware/resource/package-info.java
@@ -21,4 +21,4 @@
* This is a low-level API.
*/
@org.osgi.annotation.versioning.Version("1.0.0")
-package org.apache.sling.config.resource;
+package org.apache.sling.contextaware.resource;
diff --git a/src/test/java/org/apache/sling/config/spi/metadata/ConfigurationMetadataTest.java b/src/test/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationMetadataTest.java
similarity index 91%
rename from src/test/java/org/apache/sling/config/spi/metadata/ConfigurationMetadataTest.java
rename to src/test/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationMetadataTest.java
index 50c6dd5..556337a 100644
--- a/src/test/java/org/apache/sling/config/spi/metadata/ConfigurationMetadataTest.java
+++ b/src/test/java/org/apache/sling/contextaware/config/spi/metadata/ConfigurationMetadataTest.java
@@ -16,12 +16,14 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
+import org.apache.sling.contextaware.config.spi.metadata.ConfigurationMetadata;
+import org.apache.sling.contextaware.config.spi.metadata.PropertyMetadata;
import org.junit.Test;
public class ConfigurationMetadataTest {
diff --git a/src/test/java/org/apache/sling/config/spi/metadata/PropertyMetadataTest.java b/src/test/java/org/apache/sling/contextaware/config/spi/metadata/PropertyMetadataTest.java
similarity index 93%
rename from src/test/java/org/apache/sling/config/spi/metadata/PropertyMetadataTest.java
rename to src/test/java/org/apache/sling/contextaware/config/spi/metadata/PropertyMetadataTest.java
index 60fab1b..66ae8b3 100644
--- a/src/test/java/org/apache/sling/config/spi/metadata/PropertyMetadataTest.java
+++ b/src/test/java/org/apache/sling/contextaware/config/spi/metadata/PropertyMetadataTest.java
@@ -16,11 +16,12 @@
* specific language governing permissions and limitations
* under the License.
*/
-package org.apache.sling.config.spi.metadata;
+package org.apache.sling.contextaware.config.spi.metadata;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
+import org.apache.sling.contextaware.config.spi.metadata.PropertyMetadata;
import org.junit.Test;
public class PropertyMetadataTest {
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.