[
https://issues.apache.org/jira/browse/SLING-4377?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14323791#comment-14323791
]
Carsten Ziegeler commented on SLING-4377:
-----------------------------------------
Thanks for the hard work, [~kwin]
The changes look good to me, with some minor exceptions:
- with this in place, we require Java 6 for the API; I don't think this is a
problem, but we should be aware of it
- ResourceProvider#listChildren is allowed to return null - we should enhance
the javadocs to mention this
+1 for applying it (with the above change)
> Add JSR305 nullness annotations to Sling API
> --------------------------------------------
>
> Key: SLING-4377
> URL: https://issues.apache.org/jira/browse/SLING-4377
> Project: Sling
> Issue Type: Improvement
> Components: API
> Reporter: Konrad Windszus
> Assignee: Konrad Windszus
>
> Since consumers of the Sling API always have to keep in mind whether a
> null-check is necessary it would be good to add JSR 305 annotations to the
> API.
> See also http://www.mail-archive.com/[email protected]/msg42199.html.
> At least Eclipse as well as Findbugs are supporting those and Oak Solr is
> using those already (https://issues.apache.org/jira/browse/OAK-2303).
> Only the following 2 annotations should be used:
> # {{@Nonnull}}, for return values which are not supposed to be {{null}} or
> parameters which must not be {{null}}.
> # {{@CheckForNull}}, for return values wich may be null {{null}}.
> Those are the only ones being supported by both Eclipse and Findbugs (compare
> with http://sourceforge.net/p/findbugs/bugs/1355/)
> {{@Nullable}} is basically ignored by Findbugs
> (http://findbugs.sourceforge.net/manual/annotations.html) and should
> therefore not be used. The package annotation for the default handling should
> also not be used (because either {{@Nullable}} or {{@CheckForNull}} is
> ignored by Eclipse then.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
