このエントリーをはてなブックマークに追加

JavaDoc

メソッドの最初にエラーをチェックするとかに使います。 それ以外のチェック用としては、Verifierクラスがあります。

返り値 タイプ 用途
void checkArgument(boolean expression) 引数の状態に問題有り
int checkElementIndex(int index, int size) 範囲がおかしい(配列のindex)
T checkNotNull(T reference) 値がnull
int checkPositionIndex(int index, int size) 範囲がおかしい(テキストのカーソル位置とか)
void checkState(boolean expression) 引数以外の状態に問題有り

checkElementIndexやcheckNotNull・checkPositionIndexは、値を返すので、引数以外に使ってもコードがスッキリします。

ただその場合エラー発生時に、何が問題かのメッセージをわかりやすく追加したほうがよさそう。

引数のコメントとか省く場合とか、このcheck系があれば、後で可読性が高くなりそうです。

EclipseとかだとPreference/Java/Editor/Content Assistant/Favorites/からお気に入りに、このクラスを登録すると、使いやすくなります。

テンプレート

%sのみ対応していて、好きなだけ引数に置き換える値を追加するといいです。