注釈インタフェースDeprecated
@Documented @Retention(RUNTIME) @Target({CONSTRUCTOR,FIELD,LOCAL_VARIABLE,METHOD,PACKAGE,MODULE,PARAMETER,TYPE}) public @interface Deprecated
@Deprecatedという注釈の付いたプログラ 要 は、プログラマが使用できないプログラ 要 です。 要 は、いくつかの理由のいずれかで非推奨になることがあります。たとえば、その使用はエラーにつながる可能性があります。互換性のない変更や、将来のバージョンで削除される可能性があります。新しい、通常は推奨される代替によって置き換えられるか、または廃止されます。
非推奨のコードで非推奨のプログラ 要 が使用またはオーバーライドされると、コンパイラは警告を発行します。 @Deprecated注釈をローカル変数宣言、パラメータ宣言またはパッケージ宣言で使用しても、コンパイラによって発行された警告には影響しません。
モジュールが非推奨になると、そのモジュールが requiresで使用され、exports句またはopens句で使用されないと、警告が発行されます。 非推奨になっているモジュールでは、モジュール内の型の使用に関する警告は発行されません。
この注釈型には、文字列値の要 sinceがあります。 この要 の値は、注釈付きプログラ 要 が最初に非推奨になったバージョンを示します。
この注釈型には、ブール値の要 forRemovalがあります。 trueの値は、将来のバージョンで注釈付きプログラ 要 を削除することを示します。 値falseは、注釈付きプログラ 要 の使用が推奨されないことを示しますが、プログラ 要 に注釈が付けられた時点では、そのプログラ 要 を削除する具体的な意図はありませんでした。
- APIのノート:
@deprecatedjavadocタグを使用して、プログラ 要 を非推奨にする理由をドキュメントで説明することを強くお薦めします。 ドキュメントは、推奨される代替APIを提案し、該当する 合はリンクする必要があります。 置換APIのセマンティクスは微妙に異なることが多いため、このような問題についても検討する必要があります。since値には、新しく注釈が付けられたすべてのプログラ 要 を指定することをお薦めします。 この要 値がない多くの既存の注釈があるため、sinceは必 にできません。注釈要 間に定義された 序はありません。 スタイルの問題として、
since要 を先に配置する必要があります。@Deprecated注釈は、@deprecatedjavadocタグが存在する 合は常に存在し、その逆も同様です。- Java言語仕様を参照してく さい:
-
9.6.4.6 @Deprecated
- 導入されたバージョン:
- 1.5
-
オプション要 のサマリー
任意要修飾子と型オプション要説明boolean注釈付き要 が将来のバージョンで削除される可能性があるかどうかを示します。注釈付き要 が非推奨になったバージョンを返します。
-
要 の詳細
-
since
String since注釈付き要 が非推奨になったバージョンを返します。 バージョン文字列は、@sincejavadocタグの値と同じ形式およびネー スペースです。 デフォルト値は空の文字列です。- 戻り値:
- バージョン文字列
- 導入されたバージョン:
- 9
- デフォルト:
""
-
forRemoval
boolean forRemoval注釈付き要 が将来のバージョンで削除される可能性があるかどうかを示します。 デフォルト値はfalseです。- 戻り値:
- 要 が削除対象かどうか
- 導入されたバージョン:
- 9
- デフォルト:
false
-