Java 9の@Deprecatedアノテーションに新しく追加された属性とは？

Java 9では、@Deprecatedアノテーションに2つの新しいパラメータ（属性）が追加されました。それが「since」と「forRemoval」です。どちらも省略可能なオプション属性であり、明示的に指定しなかった場合はデフォルト値が適用されます。

これらの属性により、APIがいつ非推奨になったのか、そして将来的に削除される予定があるのかどうかを、開発者がより明確に伝えられるようになりました。

since属性

文字列型（String）のパラメータで、そのAPIがどのバージョンで非推奨（deprecated）になったかを指定します。デフォルト値は空文字列です。

構文

@Deprecated(since="<version>")

forRemoval属性

boolean型のパラメータで、そのAPIが将来のリリースで削除される予定かどうかを指定します。指定しない場合のデフォルト値はfalseです。

構文

@Deprecated(forRemoval=<boolean>)

コード例

以下は、両方の属性を使った具体的な使用例です。

public class DeprecatedAnnotationTest {
    public static void main(String[] args) {
        DeprecatedAnnotationTest test = new DeprecatedAnnotationTest();
        test.method1();
        test.method2();
    }
    @Deprecated(since="7.0")
    public void method1() {
        System.out.println("@Deprecated(since=\"7.0\")");
    }
    @Deprecated(since="5.0", forRemoval=true)
    public void method2() {
        System.out.println("@Deprecated(since=\"5.0\", forRemoval=true)");
    }
}

実行結果

@Deprecated(since="7.0")
@Deprecated(since="5.0", forRemoval=true)

まとめ

Java 9以降の@Deprecatedアノテーションでは、「since」で非推奨となったバージョンを示し、「forRemoval=true」で将来の削除が予定されていることを明示できます。特にforRemovalがtrueの場合、コンパイラやIDEは通常よりも強い警告を表示するため、ライブラリやフレームワークを開発する際には積極的な活用が推奨されます。