commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject [LANG] 3.0 JCIP Annotations
Date Wed, 18 Mar 2009 15:51:22 GMT
I've added JCIP annotations jar to the POM, but not started adding any
actual annotations yet.

The idea would be to annotate every class as one of

@Immutable
@ThreadSafe
@NotThreadSafe

These annotation appear in the Javadoc output in the class description.

Also, for objects that need synchronization to ensure thread safety,
add the annotation

@GuardedBy

Are there any objections to proceeding with this?

It's probably easiest to deal with @Immutable first, then @ThreadSafe.

If no annotation is present, then the user _should_ assume that the
class is @NotThreadSafe, but I think it would be better to always have
an annotation so that it's clear it has not been accidentally left
off.

WDYT?

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message