[GitHub] [sling-org-apache-sling-resourceresolver] rombert commented on a change in pull request #20: SLING-9676 - Improve Javadoc for MapEntriesHandler

[GitBox <gi...@apache.org>]

rombert commented on a change in pull request #20:
URL: https://github.com/apache/sling-org-apache-sling-resourceresolver/pull/20#discussion_r474505370



##########
File path: src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntry.java
##########
@@ -268,7 +267,12 @@ public MapEntry(String url, final int status, final boolean trailingSlash,
         this.order = order;
     }
 
-    // Returns the replacement or null if the value does not match
+    /**
+     * Replaces the specified value according to the rules of this entry
+     * 
+     * @param value the value to replace
+     * @return a replaced value of <code>null</code> if the value does not match
+     */
     public String[] replace(final String value) {

Review comment:
       I've added the nullability annotations, it makes sense. I think adding them to just one method helps in the sense that missing annotations don't trigger any incorrect assumptions.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org