Add Jetbrains NotNull/Nullable annotations to API.

wcm-io · Aug 14, 2018 · 1b38e4c · 1b38e4c
1 parent 8bad8db
commit 1b38e4c
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 14 deletions.
diff --git a/ui/granite/changes.xml b/ui/granite/changes.xml
@@ -23,6 +23,12 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
+    <release version="1.1.6" date="not released">
+      <action type="update" dev="sseifert">
+        Add Jetbrains NotNull/Nullable annotations to API.
+      </action>
+    </release>
+
     <release version="1.1.4" date="2018-05-26">
       <action type="update" dev="sseifert">
         Set javax.inject dependency to provided.

diff --git a/ui/granite/src/main/java/io/wcm/wcm/ui/granite/emulator/impl/EmulatorProviderImpl.java b/ui/granite/src/main/java/io/wcm/wcm/ui/granite/emulator/impl/EmulatorProviderImpl.java
@@ -81,6 +81,7 @@ void activate(Config config) {
     }
   }
 
+  @SuppressWarnings("null")
   @Override
   public boolean handles(Resource resource) {
     // check if resource is a page, and if the page uses a configured template
@@ -109,6 +110,7 @@ public List<Emulator> getEmulators(Resource resource) {
     return emulators;
   }
 
+  @SuppressWarnings({ "null", "unused" })
   @Override
   public List<EmulatorGroup> getEmulatorGroups(Resource resource) {
     // convert device groups defined in page props to emulator groups

diff --git a/ui/granite/src/main/java/io/wcm/wcm/ui/granite/resource/GraniteUiSyntheticResource.java b/ui/granite/src/main/java/io/wcm/wcm/ui/granite/resource/GraniteUiSyntheticResource.java
@@ -31,6 +31,7 @@
 import org.apache.sling.api.resource.SyntheticResource;
 import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.api.wrappers.ValueMapDecorator;
+import org.jetbrains.annotations.NotNull;
 
 import com.day.cq.commons.jcr.JcrConstants;
 import com.google.common.collect.ImmutableList;
@@ -111,7 +112,8 @@ private void addChild(Resource child) {
    * @param valueMap Properties
    * @return Resource
    */
-  public static Resource create(ResourceResolver resourceResolver, ValueMap valueMap) {
+  @SuppressWarnings("null")
+  public static Resource create(@NotNull ResourceResolver resourceResolver, @NotNull ValueMap valueMap) {
     return create(resourceResolver, null, JcrConstants.NT_UNSTRUCTURED, valueMap);
   }
 
@@ -122,7 +124,8 @@ public static Resource create(ResourceResolver resourceResolver, ValueMap valueM
    * @param resourceType Resource type
    * @return Resource
    */
-  public static Resource create(ResourceResolver resourceResolver, String path, String resourceType) {
+  @SuppressWarnings("null")
+  public static Resource create(@NotNull ResourceResolver resourceResolver, @NotNull String path, @NotNull String resourceType) {
     return create(resourceResolver, path, resourceType, ValueMap.EMPTY);
   }
 
@@ -134,7 +137,8 @@ public static Resource create(ResourceResolver resourceResolver, String path, St
    * @param valueMap Properties
    * @return Resource
    */
-  public static Resource create(ResourceResolver resourceResolver, String path, String resourceType, ValueMap valueMap) {
+  public static Resource create(@NotNull ResourceResolver resourceResolver, @NotNull String path, @NotNull String resourceType,
+      @NotNull ValueMap valueMap) {
     return new GraniteUiSyntheticResource(resourceResolver,
         path,
         resourceType,
@@ -147,7 +151,7 @@ public static Resource create(ResourceResolver resourceResolver, String path, St
    * @param resource Real resource
    * @return Resource
    */
-  public static Resource wrap(Resource resource) {
+  public static Resource wrap(@NotNull Resource resource) {
     return wrap(resource, resource.getValueMap(), resource.getChildren());
   }
 
@@ -157,7 +161,7 @@ public static Resource wrap(Resource resource) {
    * @param valueMap Properties to use instead of the real properties
    * @return Resource
    */
-  public static Resource wrap(Resource resource, ValueMap valueMap) {
+  public static Resource wrap(@NotNull Resource resource, @NotNull ValueMap valueMap) {
     return wrap(resource, valueMap, resource.getChildren());
   }
 
@@ -168,7 +172,7 @@ public static Resource wrap(Resource resource, ValueMap valueMap) {
    * @param valueMap Properties to be merged with the real properties
    * @return Resource
    */
-  public static Resource wrapMerge(Resource resource, ValueMap valueMap) {
+  public static Resource wrapMerge(@NotNull Resource resource, @NotNull ValueMap valueMap) {
     Map<String, Object> mergedProperties = new HashMap<>();
     mergedProperties.putAll(resource.getValueMap());
     mergedProperties.putAll(valueMap);
@@ -190,7 +194,8 @@ private static Resource wrap(Resource resource, ValueMap valueMap, Iterable<Reso
    * @param resourceType Resource type
    * @return Resource
    */
-  public static Resource child(Resource parentResource, String name, String resourceType) {
+  @SuppressWarnings("null")
+  public static Resource child(@NotNull Resource parentResource, @NotNull String name, @NotNull String resourceType) {
     return child(parentResource, name, resourceType, ValueMap.EMPTY);
   }
 
@@ -202,7 +207,8 @@ public static Resource child(Resource parentResource, String name, String resour
    * @param valueMap Properties
    * @return Resource
    */
-  public static Resource child(Resource parentResource, String name, String resourceType, ValueMap valueMap) {
+  public static Resource child(@NotNull Resource parentResource, @NotNull String name, @NotNull String resourceType,
+      @NotNull ValueMap valueMap) {
     Resource child = new GraniteUiSyntheticResource(parentResource.getResourceResolver(),
         parentResource.getPath() + "/" + name,
         resourceType,

diff --git a/ui/granite/src/main/java/io/wcm/wcm/ui/granite/resource/package-info.java b/ui/granite/src/main/java/io/wcm/wcm/ui/granite/resource/package-info.java
@@ -20,5 +20,5 @@
 /**
  * Helper for building virtual resource trees for Granite UI components.
  */
-@org.osgi.annotation.versioning.Version("1.0.0")
+@org.osgi.annotation.versioning.Version("1.0.1")
 package io.wcm.wcm.ui.granite.resource;
diff --git a/ui/granite/src/main/java/io/wcm/wcm/ui/granite/util/GraniteUi.java b/ui/granite/src/main/java/io/wcm/wcm/ui/granite/util/GraniteUi.java
@@ -26,6 +26,8 @@
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ResourceUtil;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import com.adobe.granite.ui.components.Value;
 import com.day.cq.wcm.api.Page;
@@ -45,7 +47,7 @@ private GraniteUi() {
    * @param request Request
    * @return Current content resource or null
    */
-  public static Resource getContentResource(HttpServletRequest request) {
+  public static @Nullable Resource getContentResource(@NotNull HttpServletRequest request) {
 
     String contentPath = getContentPath(request);
 
@@ -62,7 +64,7 @@ public static Resource getContentResource(HttpServletRequest request) {
    * @param request Request
    * @return Current content resource or the first existing parent/ancestor.
    */
-  public static Resource getContentResourceOrParent(HttpServletRequest request) {
+  public static @Nullable Resource getContentResourceOrParent(@NotNull HttpServletRequest request) {
     String contentPath = getContentPath(request);
     return getContentResourceOrParentFromPath((SlingHttpServletRequest)request, contentPath);
   }
@@ -73,7 +75,7 @@ public static Resource getContentResourceOrParent(HttpServletRequest request) {
    * @param request Request
    * @return Current content page or null
    */
-  public static Page getContentPage(HttpServletRequest request) {
+  public static @Nullable Page getContentPage(@NotNull HttpServletRequest request) {
     SlingHttpServletRequest slingRequest = (SlingHttpServletRequest)request;
     Resource contentResource = getContentResourceOrParent(request);
     if (contentResource != null) {
@@ -91,7 +93,7 @@ public static Page getContentPage(HttpServletRequest request) {
    * @param resourceTypes ResourceTypes
    * @return Existing resource type
    */
-  public static String getExistingResourceType(ResourceResolver resourceResolver, String... resourceTypes) {
+  public static @Nullable String getExistingResourceType(@NotNull ResourceResolver resourceResolver, @NotNull String @NotNull... resourceTypes) {
     for (String path : resourceTypes) {
       if (resourceResolver.getResource(path) != null) {
         return path;

diff --git a/ui/granite/src/main/java/io/wcm/wcm/ui/granite/util/package-info.java b/ui/granite/src/main/java/io/wcm/wcm/ui/granite/util/package-info.java
@@ -20,5 +20,5 @@
 /**
  * Helper methods for Granite UI components.
  */
-@org.osgi.annotation.versioning.Version("1.1.0")
+@org.osgi.annotation.versioning.Version("1.1.1")
 package io.wcm.wcm.ui.granite.util;
diff --git a/ui/granite/src/test/java/io/wcm/wcm/ui/granite/resource/GraniteUiSyntheticResourceTest.java b/ui/granite/src/test/java/io/wcm/wcm/ui/granite/resource/GraniteUiSyntheticResourceTest.java
@@ -41,6 +41,7 @@
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 
+@SuppressWarnings("null")
 public class GraniteUiSyntheticResourceTest {
 
   private static final ValueMap SAMPLE_PROPERTES = new ValueMapDecorator(ImmutableMap.<String, Object>builder()

diff --git a/ui/granite/src/test/java/io/wcm/wcm/ui/granite/util/GraniteUiTest.java b/ui/granite/src/test/java/io/wcm/wcm/ui/granite/util/GraniteUiTest.java
@@ -39,6 +39,7 @@
 import com.day.cq.wcm.api.PageManager;
 
 @RunWith(MockitoJUnitRunner.class)
+@SuppressWarnings("null")
 public class GraniteUiTest {
 
   private static final String CONTENT_PATH = "/my/path";