クラスやメソッドを非推奨(deprecated)にする
開発が進んで行くと既存の機能と同じ機能を改良した新しいクラスやメソッドを作成することがあります。
その際に「既存の呼び出しコードを変更することは出来ないが、今後は新しい方を使用して欲しい」といった場合に既存のクラス・メソッドを残しつつ非推奨とする方法です。
Javadocを使う
@deprecatedタグを使用します。
加えて{@link}タグで今後使うクラス・メソッドを指定しておくと分かり易いですね。
/**
* Sample method.
* @deprecated 非推奨です。今後は {@link #newMethod()} を使用してください。
*/
private void oldMethod() {
}
/**
* New sample method.
*/
private void newMethod() {
}
/**
* Sample class.
* @deprecated 非推奨です。今後は {@link NewClass } を使用してください。
*/
class OldClass {
}
/**
* New sample class.
*/
class NewClass {
}
アノテーションを使う
@Deprecatedアノテーションを使用する方法です。
但し、Java SE 5未満では使用できないようです。
@Deprecated
private void oldMethod2() {
}
@Deprecated
class OldClass2 {
}
結果表示
Android Studioやeclipseではこんな感じで非推奨が取り消し線で表示され、分かり易くなります。
クラスやメソッドを非推奨(deprecated)にする