@ThreadSafe アノテーションはいつ・どのような目的で使うのでしょうか？

Question

以下のリンクによると @ThreadSafe アノテーション自体には Thread Safe にする機能がないとありますが、

Annotation called ThreadSafe

その場合、@ThreadSafe を使う主な目的は何になるのでしょうか？
0. synchronized や final を使うなど（たとえマルチスレッドで実行されても）明示的にスレッドセーフが実現されている場合に
0. （マルチスレッドなどで）実行を試みる人に
0. （スレッドセーフのため）追加でスレッドセーフ処理が必要ないことを知らせるため

などになるのでしょうか。言い換えると、スレッドセーフのための処理を施した場合は、基本的には @ThreadSafe アノテーションをつけるべきなのでしょうか。

スレッドセーフにしたつもりが @ThreadSafe をつけたものの、実際はスレッドセーフになっていなかったということも理論的には考えられることになると、@ThreadSafe はいつつけるべきなのだろうかと、少し混乱してしまった次第です。

Answer 1

アノテーションの元ソースを確認すれば、わかるんだけど

@Retention(RetentionPolicy.SOURCE)

が付与されているアノテーションはコンパイル後に消えます。
Javadocに製作者が利用者にそのアノテーションの定義を保証していることになります。

つまり

@ThreadSafe を付与したものは

貴方がこれはスレッドセーフなので安心して利用してください

というためだけのものです。

なのでアノテーションの種類に

@Retention(RetentionPolicy.SOURCE)

となっているものは、コンパイル時やJavadoc 作成時に参照されるのみです。

Comments

[afild]

ありがとうございます！そうなるとますます使い所が（私みたいな頭の弱い人には）わかりにくいというか、何かこう指針のようなものがあるとより読みやすいコードが書けるのかなと思いました次第です。恐らく私の経験や知識が足りてないところに大きな要因がある気がしますのでしばらくは手を動かしてみようと思います。

Answer 2

まずアノテーションって難しいですよね。
@Overrideや@Deprecationも、必須ではないですし、見た目上はあまり変わりません。

じゃあなぜつけるのか、と聞かれたらわかりやすいからでしょうか。
特に、ライブラリを作る場合それが必要と考えています。

@Overrideを使うと、javadocでもどこを継承したかわかりやすい、関数名のスペルミス時、エラーが出る、とかそんな程度です。

話がそれましたが、個人の意見で言えば、

（マルチスレッドなどで）実行を試みる人に

というのは少し違う気がします。まず、マルチスレッドで使用するような関数を作るのは自分なので、
試みて(実行して)問題ない、というのを示す、3が一番近いと思います。

言い換えると、スレッドセーフのための処理を施した場合は、基本的には @ThreadSafe アノテーションをつけるべきなのでしょうか。

マルチスレッドで実行される可能性の高い、マルチスレッドで使用されることを想定した関数で、スレッドセーフを施したものにつける、べきだと思います。

Comments

[afild]

ご丁寧にありがとうございます！お二方ともご回答大変参考になったのですが、なんとなく初心者の私の気持ちに触れてくださったということでベストアンサーにさせていただきました（もちろん内容もお二方ともとても有り難かったです）

Java か C++ か少し曖昧ですが @Override は親クラスに該当メソッドがなければコンパイルエラーになありませんでしたっけ…？というのも、そうしたわかりやすい実用性が少しでもあるともう少し「ああ、なるほど」という気持ちになったかもしれず。