Javadocのダウンロードから読み方を徹底解説

Javaの開発を実施しているとライブラリが持っている機能について知りたくなる場合があります。

例えば、文字列からn番目の1文字を取得したい場合に何かよいメソッドが定義されていないかな？またそのメソッドはどのように使えばよいのかな？といった場合です。

そのような場合に活用するのがJavadocですが、大量の情報を持っているためすべてを読み解こうと思うとなかなか大変です。

そこで、これだけ知っておけばJava開発に困らないであろうと思われるポイントに絞って実用的な解説します。

Javadocのダウンロード

ライブラリによってもダウンロード先は異なりますが、まずJavaSEが持っている標準APIのJavadocを入手しましょう。

赤枠で囲ったリンクからJavadocをダウンロードすることが出来ます。

バージョンは貴方がインストールしたJDKのバージョンと同じにしておきましょう。

ダウンロード後zipファイルを解凍すると以下のようになっています。

解凍すると、「index.html」がありますのでこちらをダブルクリックして開きます。

index.htmlを開くとたくさんのリンクがありますが、「Java SE API」をクリックすると、Java API仕様の画面が開きます。

画面は3つのエリアに分かれます。

ここで目的のクラスのパッケージを指定します。指定しない場合は上図の②にすべてのクラスが表示されます。

目的のクラスを選択します。選択すると上図の③にクラスの説明とコンストラクタ、メソッドの説明と利用方法が記述されています。

以下java.lang.Stringクラスを例に具体的なjavadocの読み解き方を解説します。

説明部は主に以下のパートから構成されています。

冒頭にクラスの説明が記述されています。特に説明不要と思いますので割愛します。

ここにはクラスがもつコンストラクタの説明が記述されています。目的のクラスがどのようなコンストラクタを持っていて、引数は何をとるのか確認することが出来ます。

クラスが持つ、メソッドの一覧が表示されます。この一覧だけでも機能概要、引数、戻り値を知ることが出来ますが、メソッド名のリンクをクリックすると詳細を見ることが出来ます。

上図ではString.charAtメソッドを例に説明します。

戻り値の型はcharということが分かります。また、図の下部に「戻り値：」と記述された箇所にどのような戻り値が返るかについての説明が記述されています。

メソッド名です。

int型の引数を1つ取ることが分かります。また、図の下部に「パラメータ：」と記述された箇所にどのような引数を渡すかについての説明が記述されています。

メソッドの説明が記述されています。

このメソッドを作成したときにthrowsやthrowで例外を発生させている例外があることが分かります。

多少間違いはありますが、要は実行したときに発生する可能性がある例外を示していると言っても良いでしょう。

(例えばNullPointerExceptionなども発生する可能性はありますが、メソッド内でthrowsやthrowで明示的に定義されているわけではないと言うことです)

ちなみに、この場合のIndexOutOfBoundsExceptionとはStringの文字列の数を超えたインデックスを指定した場合に発生します。