com.github.mygreen.cellformatter.lang

クラス EraPeriod

java.lang.Object

com.github.mygreen.cellformatter.lang.EraPeriod

public class EraPeriod
extends Object

平成などの時代の期間を表すクラス。

バージョン:

0.5

作成者:

T.TSUCHIE

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static EraPeriod	UNKNOWN_PERIOD 不明な時代の期間を示すクラス。

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

コンストラクタ

コンストラクタと説明
EraPeriod()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	contains(Date date) 指定した日時が含まれているかどうか。
String	getAbbrevName() 元号のロケールに対する省略名を取得する。
String	getAbbrevRomanName() 元号のローマ字の省略名を取得する。
Date	getEndDate() 終了日を取得する
int	getEraYear(Calendar cal) 指定した日時が、開始日時から経過した年を取得する。
String	getName() 元号の名称を取得する
Date	getStartDate() 開始日を取得する
boolean	isUnknown() 不明な期間かどうか。
String	toString()

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

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

フィールドの詳細

UNKNOWN_PERIOD

public static final EraPeriod UNKNOWN_PERIOD

不明な時代の期間を示すクラス。

存在しない期間を示すにも使用する。

導入されたバージョン:

0.5

コンストラクタの詳細

EraPeriod

public EraPeriod()

メソッドの詳細

contains

public boolean contains(Date date)

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

パラメータ:

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

戻り値:

true:この時代に含まれている。

例外:

IllegalArgumentException - date == null.

getEraYear

public int getEraYear(Calendar cal)

指定した日時が、開始日時から経過した年を取得する。

パラメータ:

cal - チェック対象の日時。タイムゾーンは、GMT-00:00である必要がある。

戻り値:

例外:

IllegalArgumentException - cal == null.

toString

public String toString()

オーバーライド:

toString クラス内 Object

getAbbrevRomanName

public String getAbbrevRomanName()

元号のローマ字の省略名を取得する。

戻り値:

getAbbrevName

public String getAbbrevName()

元号のロケールに対する省略名を取得する。

戻り値:

日本語の場合、「平成」だと「平」の値。

getName

public String getName()

元号の名称を取得する

戻り値:

getStartDate

public Date getStartDate()

開始日を取得する

戻り値:

getEndDate

public Date getEndDate()

終了日を取得する

戻り値:

終了日がない現行の元号の場合はnullを返す。

isUnknown

public boolean isUnknown()

不明な期間かどうか。

戻り値:

UNKNOWN_PERIODのインスタンスのとき、trueを返す。

導入されたバージョン:

0.5