jp.finaluna.api.type.util
インタフェース DateFormatUtil


@Rcsid(value="$Revision: 38309 $ $Date: 2010-03-18 17:14:55 +0900 $")
public interface DateFormatUtil

日付文字列の出力、解析を行うユーティリティ

パターンを指定して、日付文字列の出力、解析を行う。

パターンは以下の文字列を組み合わせて指定する。

G元号和暦用ロケールが設定されている場合、Gの数で和暦情報プロパティファイルに 定義されているどの和暦表記を使用するかを決定する。
(例)和暦情報プロパティが「19890108=h,H,平成」の場合、G→「h」、GG→「H」、GGG→「平成」
y(例:2009年) yyyy→「2009」、yy→「09」、(和暦用ロケールで)yy→「21」
M(例:3時) MM→「03」
d(例:3日) dd→「03」
H時(24h表記)(例:午後1時) HH→「13」
m(例:15分) mm→「15」
s(例:20秒) ss→「20」
Sミリ秒(例:123ミリ秒) SSS→「123」ミリ秒未満は切り捨て
Nナノ秒(例:123456789ナノ秒) NNNNNNNNN→「123456789」※ミリ秒を含む
Zタイムゾーン(例:日本時間) Z→「+0900」

バージョン:
$Revision: 38309 $ $Date: 2010-03-18 17:14:55 +0900 $
作成者:
NTTデータ

メソッドの概要
 StringCode format(DateAndTimeType dateTime, StringCode pattern)
           指定されたパターンでDateAndTimeTypeを変換した日時文字列を StringCode で取得する。
 StringCode format(DateType date, StringCode pattern)
           指定されたパターンでDateTypeを変換した日付文字列を StringCode で取得する。
 StringCode format(TimestampType timestamp, StringCode pattern)
           指定されたパターンでTimestampTypeを変換したタイムスタンプ文字列を StringCode で取得する。
 StringCode format(TimeType time, StringCode pattern)
           指定されたパターンでTimeTypeを変換した時刻文字列を StringCode で取得する。
 boolean isDateString(StringCode dateString, StringCode pattern)
           指定された日付文字列が、カレンダーに存在する日付かを判定する。
 DateAndTimeType toDateAndTimeType(StringCode dateAndTimeString, StringCode pattern)
           指定されたパターンで日時文字列を変換し、 DateAndTimeType で取得する。
 DateType toDateType(StringCode dateString, StringCode pattern)
           指定されたパターンで日付文字列を変換し、 DateType で取得する。
 TimestampType toTimestampType(StringCode timestampString, StringCode pattern)
           指定されたパターンでタイムスタンプ文字列を変換し、 TimestampType で取得する。
 TimeType toTimeType(StringCode timeString, StringCode pattern)
           指定されたパターンで時刻文字列を変換し、 TimeType で取得する。
 

メソッドの詳細

format

StringCode format(DateType date,
                  StringCode pattern)
                  throws FinalunaFormatException

指定されたパターンでDateTypeを変換した日付文字列を StringCode で取得する。

パラメータ:
date - 日付データ
pattern - 日付フォーマットパターン
戻り値:
フォーマットした日付文字列
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

format

StringCode format(TimeType time,
                  StringCode pattern)
                  throws FinalunaFormatException

指定されたパターンでTimeTypeを変換した時刻文字列を StringCode で取得する。

パラメータ:
time - 時刻データ
pattern - 時刻フォーマットパターン
戻り値:
フォーマットした時刻文字列
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

format

StringCode format(DateAndTimeType dateTime,
                  StringCode pattern)
                  throws FinalunaFormatException

指定されたパターンでDateAndTimeTypeを変換した日時文字列を StringCode で取得する。

パラメータ:
dateTime - 日時データ
pattern - 日時フォーマットパターン
戻り値:
フォーマットした日時文字列
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

format

StringCode format(TimestampType timestamp,
                  StringCode pattern)
                  throws FinalunaFormatException

指定されたパターンでTimestampTypeを変換したタイムスタンプ文字列を StringCode で取得する。

和暦ロケールでパターンに年(y)が指定され年号(G)が指定されていない場合はFinalunaFormatExceptionをスローする。

パラメータ:
timestamp - タイムスタンプデータ
pattern - タイムスタンプフォーマットパターン
戻り値:
フォーマットしたタイムスタンプ文字列
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

toDateType

DateType toDateType(StringCode dateString,
                    StringCode pattern)
                    throws FinalunaFormatException

指定されたパターンで日付文字列を変換し、 DateType で取得する。

和暦ロケールでパターンに年(y)が指定され年号(G)が指定されていない場合はFinalunaFormatExceptionをスローする。

パラメータ:
dateString - 日付文字列
pattern - 日付フォーマットパターン
戻り値:
解析した日付データ
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

toTimeType

TimeType toTimeType(StringCode timeString,
                    StringCode pattern)
                    throws FinalunaFormatException

指定されたパターンで時刻文字列を変換し、 TimeType で取得する。

和暦ロケールでパターンに年(y)が指定され年号(G)が指定されていない場合はFinalunaFormatExceptionをスローする。

パラメータ:
timeString - 時刻文字列
pattern - 時刻フォーマットパターン
戻り値:
解析した時刻データ
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

toDateAndTimeType

DateAndTimeType toDateAndTimeType(StringCode dateAndTimeString,
                                  StringCode pattern)
                                  throws FinalunaFormatException

指定されたパターンで日時文字列を変換し、 DateAndTimeType で取得する。

和暦ロケールでパターンに年(y)が指定され年号(G)が指定されていない場合はFinalunaFormatExceptionをスローする。

パラメータ:
dateAndTimeString - 日時文字列
pattern - 日時フォーマットパターン
戻り値:
解析した日時データ
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

toTimestampType

TimestampType toTimestampType(StringCode timestampString,
                              StringCode pattern)
                              throws FinalunaFormatException

指定されたパターンでタイムスタンプ文字列を変換し、 TimestampType で取得する。

パラメータ:
timestampString - タイムスタンプ文字列
pattern - タイムスタンプフォーマットパターン
戻り値:
解析したタイムスタンプデータ
例外:
FinalunaFormatException - フォーマット・解析処理に失敗した場合

isDateString

boolean isDateString(StringCode dateString,
                     StringCode pattern)

指定された日付文字列が、カレンダーに存在する日付かを判定する。

和暦ロケールでパターンに年(y)が指定され年号(G)が指定されていない場合はfalseを返す。

パラメータ:
dateString - 日付文字列
pattern - 日付フォーマットパターン
戻り値:
パターンに沿った日付文字列ならばtrue、そうでなければfalse