com.github.mygreen.cellformatter.lang

クラス Era

java.lang.Object

com.github.mygreen.cellformatter.lang.Era

public class Era
extends Object

時代情報の定義用のクラス。

複数の期間EraPeriodを持つ。

導入されたバージョン:

0.5

バージョン:

0.6

作成者:

T.TSUCHIE

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static Era	UNKNOWN_ERA 不明な時代情報の場合 ロケールに対して時代情報が存在しない場合に使用する。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Era(List<EraPeriod> periods) 時代の期間を指定するコンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	contains(Date date) 指定した日時が時代情報に含まれているかどうか。
EraPeriod	getTargetPeriod(Date date) 指定した日時に該当する期間情報を取得する。
boolean	isUnkndown() 不明な時代情報かどうか。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

UNKNOWN_ERA

public static final Era UNKNOWN_ERA

不明な時代情報の場合

ロケールに対して時代情報が存在しない場合に使用する。

コンストラクタの詳細

Era

public Era(List<EraPeriod> periods)

時代の期間を指定するコンストラクタ。

パラメータ:

periods - 時代の期限。

例外:

IllegalArgumentException - periods == null.

メソッドの詳細

contains

public boolean contains(Date date)

指定した日時が時代情報に含まれているかどうか。

パラメータ:

date - 判定対象の日時。タイムゾーンは、GMT-00:00である必要がある。

戻り値:

true:含まれている場合。

例外:

IllegalArgumentException - date == null.

getTargetPeriod

public EraPeriod getTargetPeriod(Date date)

指定した日時に該当する期間情報を取得する。

パラメータ:

date - 判定対象の日時。タイムゾーンは、GMT-00:00である必要がある。

戻り値:

見つからない場合は、存在しない期間を示すクラスEraPeriod.UNKNOWN_PERIODのインスタンスを返す。

例外:

IllegalArgumentException - date == null.

isUnkndown

public boolean isUnkndown()

不明な時代情報かどうか。

戻り値:

UNKNOWN_ERAのインスタンスの場合、trueを返す。