DateTimeFormatter (クラス)
public sealed DateTimeFormatter {inherits Formatter}
パッケージ： CURL.LANGUAGE.FORMAT

時刻と日付の形式設定に使うクラス。

説明

このクラスは、ロケールに応じて日付と時刻をフォーマットする機能を提供します。このクラスのコンストラクタの引数である include-date?、include-time?、style を使い、フォーマットの詳細の一部を制御できます。
DateTimeFormatter を作成したら、これを format に渡して %m フォーマット指定子との関連で使用したり、DateTimeFormatter.format メソッドを直接呼び出して DateTime オブジェクトをフォーマットすることができます。
上記の機能のほかに、このクラスは Locale に関連する各種の日付/時刻関係のパラメータの値を取得するインターフェイスも提供します。特定 Locale の DateTimeFormatter を作成した後で、この DateTimeFormatter のアクセッサ (weekday-names、month-names など) を使い、この Locale の既定値を取得できます。

コンストラクタ
default:locale での使用に適した DateTimeFormatter オブジェクトを作成します。
コンストラクタ public {DateTimeFormatter.default
locale:Locale = {get-syntax-locale},
include-date?:bool = true,
include-time?:bool = true,
style:DateTimeFormatStyle = DateTimeFormatStyle.short
}

プロパティ
am-pm-names:self の午前/午後を示す名前 (例 : 米国英語ロケール "en-US" では "AM" と "PM") の値を返します。
アクセサ public final DateTimeFormatter.am-pm-names:{ReadOnlyArray-of String}
month-names:self の完全な月名 (例 : 米国英語ロケール "en-US" では "January"、"February"など) の値を返します。
アクセサ public final DateTimeFormatter.month-names:{ReadOnlyArray-of String}
short-month-names:self の月名の省略形 (例 : 米国英語ロケール "en-US" では "Jan"、"Feb" など) の値を返します。
アクセサ public final DateTimeFormatter.short-month-names:{ReadOnlyArray-of String}
short-weekday-names:self の曜日名の省略形 (例 : 米国英語ロケール "en-US" では "Mon"、"Tue" など) の値を返します。
アクセサ public final DateTimeFormatter.short-weekday-names:{ReadOnlyArray-of String}
weekday-names:self の完全な曜日名 (例 : 米国英語ロケール "en-US" では "Monday"、"Tuesday"など) の値を返します。
アクセサ public final DateTimeFormatter.weekday-names:{ReadOnlyArray-of String}

メソッド
format:DateTime オブジェクトを文字のシーケンスにフォーマットします。
public sealed {DateTimeFormatter.format
value:any,
out:#TextOutputStream = null
}:String
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
default (コンストラクタ)
public {DateTimeFormatter.default
locale:Locale = {get-syntax-locale},
include-date?:bool = true,
include-time?:bool = true,
style:DateTimeFormatStyle = DateTimeFormatStyle.short
}

locale での使用に適した DateTimeFormatter オブジェクトを作成します。

locale: フォーマットで使用する日付と時刻表示の規則が属する Locale。
include-date?: フォーマット結果に日付情報を含めるかどうかを決定します。
include-time?: フォーマット結果に時刻情報を含めるかどうかを決定します。
style: フォーマット結果のスタイルを制御します。詳細は DateTimeFormatStyle を参照してください。


プロパティ詳細
am-pm-names (アクセサ)
アクセサ public final DateTimeFormatter.am-pm-names:{ReadOnlyArray-of String}

self の午前/午後を示す名前 (例 : 米国英語ロケール "en-US" では "AM" と "PM") の値を返します。


month-names (アクセサ)
アクセサ public final DateTimeFormatter.month-names:{ReadOnlyArray-of String}

self の完全な月名 (例 : 米国英語ロケール "en-US" では "January"、"February"など) の値を返します。


short-month-names (アクセサ)
アクセサ public final DateTimeFormatter.short-month-names:{ReadOnlyArray-of String}

self の月名の省略形 (例 : 米国英語ロケール "en-US" では "Jan"、"Feb" など) の値を返します。


short-weekday-names (アクセサ)
アクセサ public final DateTimeFormatter.short-weekday-names:{ReadOnlyArray-of String}

self の曜日名の省略形 (例 : 米国英語ロケール "en-US" では "Mon"、"Tue" など) の値を返します。


weekday-names (アクセサ)
アクセサ public final DateTimeFormatter.weekday-names:{ReadOnlyArray-of String}

self の完全な曜日名 (例 : 米国英語ロケール "en-US" では "Monday"、"Tuesday"など) の値を返します。





メソッド詳細
format (メソッド)
public sealed {DateTimeFormatter.format
value:any,
out:#TextOutputStream = null
}:String

DateTime オブジェクトを文字のシーケンスにフォーマットします。

out: この引数を null 以外の値に設定した場合、文字のシーケンスは out に書き込まれ、返される String は "" になります。 その他の場合、文字のシーケンスが String として返されます。
value: この引数は DateTime オブジェクトであることが必要です。これは DateTimeFormatter コンストラクタの引数として指定された Locale の規則に従ってフォーマットされ、同じコンストラクタの他の引数で設定されたフォーマット指定により制御されます。この引数が DateTime オブジェクトでない場合、エラーがスローされます。

戻り値

out を null 以外の値に指定した場合、返される String は "" になります。その他の場合、文字のシーケンスが String として返されます。