[LANG-1291] Provide annotations to document thread safety

• Type: New Feature
• Status: Reopened
• Priority: Major
• Resolution: Unresolved
• Component/s: lang.concurrent.*
• Assignee: Gary D. Gregory
• Reporter: Gary D. Gregory
• Created: 27/Nov/16 22:47
• Updated: 17/May/17 14:26

Description

Since already have a package called org.apache.commons.lang3.concurrent, I propose we place these annottaions in org.apache.commons.lang3.concurrent.annotation.

The annotations are:

• org.apache.commons.lang3.concurrent.annotation.GuardedBy
• org.apache.commons.lang3.concurrent.annotation.Immutable
• org.apache.commons.lang3.concurrent.annotation.NotThreadSafe
• org.apache.commons.lang3.concurrent.annotation.ThreadSafe

The inspiration for these annotations are:

• JSR 305: https://jcp.org/en/jsr/detail?id=305
• JCIP: http://jcip.net/annotations/doc/index.html
• com.google.code.findbugs : jsr305 : 3.0.1: https://search.maven.org/#artifactdetails%7Ccom.google.code.findbugs%7Cjsr305%7C3.0.1%7Cjar

The JCIP code is released under the Creative Commons Attribution License (http://creativecommons.org/licenses/by/2.5)

The NOTICE file will be updated to reflect this.

Annotation retention will be at the CLASS level which does NOT create a runtime dependency on Commons Lang.