[jira] Updated: (DIRMINA-371) Annotations to document concurrency

["Trustin Lee (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DIRMINA-371?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Trustin Lee updated DIRMINA-371:
--------------------------------

             Priority: Trivial  (was: Major)
    Affects Version/s:     (was: 2.0.0-M1)
        Fix Version/s:     (was: 2.0.0-M1)

This won't impact the core API at all.  Therefore, won't fix in 2.0.0-M1.

> Annotations to document concurrency
> -----------------------------------
>
>                 Key: DIRMINA-371
>                 URL: https://issues.apache.org/jira/browse/DIRMINA-371
>             Project: MINA
>          Issue Type: Improvement
>          Components: Core
>            Reporter: im-james
>            Priority: Trivial
>
> Concurrency is not documented and it makes it had to understand MINA.
> At the very least, I would like to see an annotation in every class that  would say "This class is access by several threads" or "This class is thread safe".
> The best things that could happen is that this project adopt the use of these annotations: GuardedBy, Immutable, NotThreadSafe, ThreadSafe
> Here is the documentation for each one of these annotations:
> http://javaconcurrencyinpractice.com/annotations/doc/index.html
> You can find the source here:
> http://javaconcurrencyinpractice.com/jcip-annotations-src.jar
> and a binary here:
> http://javaconcurrencyinpractice.com/jcip-annotations.jar
> I want to highlight that the process of adding these annotations/or any kind of concurrency documentation will make concurrency flaws easier to see. (as you know concurrency flaws are 'invisible').
> I hope that you see like me that this is a very important task to do.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.