公式ドキュメントの読み方:メソッドの使い方を調べる

公式ドキュメントの読み方~Java編
Java8から追加されたYearクラスを例に公式ドキュメントの参照に仕方を簡単にメモ

java.time Class Year

まず使用したいクラスの公式ドキュメントにアクセスします。

その後使用したいメソッドがYear.untilだとします。

ドキュメントにはこのような記述がされています。
public long until(Temporal endExclusive,TemporalUnit unit)
これはuntilメソッドにはTemporal型、TemporalUnit型の2つの引数を設定する必要があるということです。

次にTemporal型について確認します。
java.time.temporal Interface Temporal

Temporalはインターフェースで、つまりYear.untilメソッドはTemporalインターフェースを継承しているクラスなら引数として設定することができます。
ここでは以下のクラスの値を渡すことができます。
HijrahDate, Instant, JapaneseDate, LocalDate, LocalDateTime, LocalTime, MinguoDate, OffsetDateTime, OffsetTime, ThaiBuddhistDate, Year, YearMonth, ZonedDateTime

同じく2つ目の引数の型であるTemporalUnit型について確認します。
java.time.temporal Interface TemporalUnit
こちらのクラスもTemporalと同じようにインターフェースで、このTemporalUnitインターフェースを継承しているクラスなら引数として設定することができます。
こちらのChronoUnitクラスというEnumクラスを引数として渡すことができます。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です