jackrabbit-oak-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jukka Zitting (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OAK-37) Use nullability annotation to enforce/document API contract
Date Wed, 16 May 2012 10:43:02 GMT

    [ https://issues.apache.org/jira/browse/OAK-37?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13276649#comment-13276649
] 

Jukka Zitting commented on OAK-37:
----------------------------------

FindBugs annotations sound good to me as long as they don't introduce a mandatory runtime
dependency on the code (which I don't think they do).

IDE support (IntelliJ, Eclipse, etc.) is nice, but IMHO not essential. The important bit is
that we're able to configure our Maven build to check such annotations and fail the build
if the explicitly declared rules are broken.
                
> 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ürig
>
> In a discussion about exception handling on the dev list [1] Julian brough up the idea
of using nullability annotations in APIs. I think we should decide on which one to use and
start using them whereever apropriate. 

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

       

Mime
View raw message