Mailing-List: contact oak-dev-help@jackrabbit.apache.org; run by ezmlm
Precedence: bulk
Reply-To: oak-dev@jackrabbit.apache.org
Date: Wed, 9 May 2012 12:17:48 +0000 (UTC)
From: "Julian Reschke (JIRA)" <jira@apache.org>
To: oak-dev@jackrabbit.apache.org
Message-ID: 
 <442628405.43978.1336565868681.JavaMail.tomcat@hel.zones.apache.org>
In-Reply-To: 
 <1928494900.2188.1332422782079.JavaMail.tomcat@hel.zones.apache.org>
Subject: [jira] [Commented] (OAK-37) Use nullability annotation to
 enforce/document API contract
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


    [ https://issues.apache.org/jira/browse/OAK-37?page=3Dcom.atlassian.jir=
a.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D13271355=
#comment-13271355 ]=20

Julian Reschke commented on OAK-37:
-----------------------------------

I just checked with FindBugs 2.01, and annotating methods with @CheckForNul=
l and @Nonnull seemed to have the desired effect.

That being said, this appears to be a can of worms; JSR-305 is dormant; Fin=
dBugs supports the annotation using it's own package + javax.annotation.

IntelliJ is said to support them in "all" packages, but I can't test that.

There's also a Eclipse JDT extension in the works which appears to be confi=
gurable with respect to package names (http://wiki.eclipse.org/JDT_Core/Nul=
l_Analysis)

In the end we need something that has an acceptable license, and can be aut=
omatically checked; FindBugs is probably a candidate for that.

               =20
> Use nullability annotation to enforce/document API contract
> -----------------------------------------------------------
>
>                 Key: OAK-37
>                 URL: https://issues.apache.org/jira/browse/OAK-37
>             Project: Jackrabbit Oak
>          Issue Type: Improvement
>          Components: core, jcr, mk
>            Reporter: Michael D=C3=BCrig
>
> In a discussion about exception handling on the dev list [1] Julian broug=
h up the idea of using nullability annotations in APIs. I think we should d=
ecide on which one to use and start using them whereever apropriate.=20

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrato=
rs: https://issues.apache.org/jira/secure/ContactAdministrators!default.jsp=
a
For more information on JIRA, see: http://www.atlassian.com/software/jira