You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by si...@apache.org on 2019/04/09 15:19:45 UTC

[sling-whiteboard] branch master updated: [api-regions] avoid name redundancies

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

simonetripodi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new 9b2b352  [api-regions] avoid name redundancies
9b2b352 is described below

commit 9b2b352ed6686b2c7f642e925838b7e1fcced04f
Author: stripodi <st...@192.168.1.111>
AuthorDate: Tue Apr 9 17:19:38 2019 +0200

    [api-regions] avoid name redundancies
---
 feature-api-regions/README.md                          | 12 ++++++------
 .../apache/sling/feature/apiregions/ApiRegions.java    |  2 +-
 .../apiregions/io/json/ApiRegionsJSONParser.java       |  2 +-
 .../sling/feature/apiregions/ApiRegionsTest.java       | 18 +++++++++---------
 .../io/json/ApiRegionsJSONSerializerTest.java          |  4 ++--
 5 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/feature-api-regions/README.md b/feature-api-regions/README.md
index 4c4f423..de15b06 100644
--- a/feature-api-regions/README.md
+++ b/feature-api-regions/README.md
@@ -90,14 +90,14 @@ omit imports for brevity;
 ...
 
 ApiRegions apiRegions = new ApiRegions();
-ApiRegion granpa = apiRegions.addNewRegion("granpa");
-granpa.addApi("org.apache.sling.feature.apiregions");
+ApiRegion granpa = apiRegions.addNew("granpa");
+granpa.add("org.apache.sling.feature.apiregions");
 
-ApiRegion father = apiRegions.addNewRegion("father");
-father.addApi("org.apache.sling.feature.apiregions.io");
+ApiRegion father = apiRegions.addNew("father");
+father.add("org.apache.sling.feature.apiregions.io");
 
-ApiRegion child = apiRegions.addNewRegion("child");
-child.addApi("org.apache.sling.feature.apiregions.io.json");
+ApiRegion child = apiRegions.addNew("child");
+child.add("org.apache.sling.feature.apiregions.io.json");
 
 for (ApiRegion region : apiRegions) {
     System.out.println("-" + region.getName());
diff --git a/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/ApiRegions.java b/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/ApiRegions.java
index 53735e9..2ebeaa6 100644
--- a/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/ApiRegions.java
+++ b/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/ApiRegions.java
@@ -23,7 +23,7 @@ public final class ApiRegions implements Iterable<ApiRegion> {
 
     private final Stack<ApiRegion> regions = new Stack<>();
 
-    public ApiRegion addNewRegion(String regionName) {
+    public ApiRegion addNew(String regionName) {
         if (regionName == null || regionName.isEmpty()) {
             throw new IllegalArgumentException("Impossible to create a new API Region without specifying a valid name");
         }
diff --git a/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONParser.java b/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONParser.java
index 294914d..35aebee 100644
--- a/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONParser.java
+++ b/feature-api-regions/src/main/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONParser.java
@@ -126,7 +126,7 @@ public final class ApiRegionsJSONParser implements JSONConstants {
                     && !regionName.isEmpty()
                     && apis != null
                     && !apis.isEmpty()) {
-                ApiRegion apiRegion = apiRegions.addNewRegion(regionName);
+                ApiRegion apiRegion = apiRegions.addNew(regionName);
                 apiRegion.addAll(apis);
             }
         }
diff --git a/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/ApiRegionsTest.java b/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/ApiRegionsTest.java
index fd2a85a..57e14c8 100644
--- a/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/ApiRegionsTest.java
+++ b/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/ApiRegionsTest.java
@@ -47,12 +47,12 @@ public class ApiRegionsTest {
 
     @Test(expected = IllegalArgumentException.class)
     public void canNotCreateRegionWithNullName() {
-        apiRegions.addNewRegion(null);
+        apiRegions.addNew(null);
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void canNotCreateRegionWithEmptyName() {
-        apiRegions.addNewRegion("");
+        apiRegions.addNew("");
     }
 
     @Test
@@ -75,7 +75,7 @@ public class ApiRegionsTest {
         assertTrue(apiRegions.isEmpty());
 
         String regionName = "registered";
-        ApiRegion region = apiRegions.addNewRegion(regionName);
+        ApiRegion region = apiRegions.addNew(regionName);
         assertNotNull(region);
         assertFalse(apiRegions.isEmpty());
         assertNotNull(apiRegions.getByName(regionName));
@@ -83,9 +83,9 @@ public class ApiRegionsTest {
 
     @Test
     public void sequentialInheritance() {
-        ApiRegion granpa = apiRegions.addNewRegion("granpa");
-        ApiRegion father = apiRegions.addNewRegion("father");
-        ApiRegion child = apiRegions.addNewRegion("child");
+        ApiRegion granpa = apiRegions.addNew("granpa");
+        ApiRegion father = apiRegions.addNew("father");
+        ApiRegion child = apiRegions.addNew("child");
 
         assertSame(father, child.getParent());
         assertSame(granpa, father.getParent());
@@ -94,9 +94,9 @@ public class ApiRegionsTest {
 
     @Test
     public void iteratingOverRegions() {
-        apiRegions.addNewRegion("granpa");
-        apiRegions.addNewRegion("father");
-        apiRegions.addNewRegion("child");
+        apiRegions.addNew("granpa");
+        apiRegions.addNew("father");
+        apiRegions.addNew("child");
 
         List<String> expected = Arrays.asList("granpa", "father", "child");
 
diff --git a/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONSerializerTest.java b/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONSerializerTest.java
index 13db6ee..b7b4eeb 100644
--- a/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONSerializerTest.java
+++ b/feature-api-regions/src/test/java/org/apache/sling/feature/apiregions/io/json/ApiRegionsJSONSerializerTest.java
@@ -64,11 +64,11 @@ public final class ApiRegionsJSONSerializerTest {
 
         ApiRegions apiRegions = new ApiRegions();
 
-        ApiRegion base = apiRegions.addNewRegion("base");
+        ApiRegion base = apiRegions.addNew("base");
         base.add("org.apache.felix.inventory");
         base.add("org.apache.felix.metatype");
 
-        ApiRegion extended = apiRegions.addNewRegion("extended");
+        ApiRegion extended = apiRegions.addNew("extended");
         extended.add("org.apache.felix.scr.component");
         extended.add("org.apache.felix.scr.info");