Date関数は、特定の日付からの月情報の取得や日付に対する時間の追加などのアクションをDateオブジェクトに対して実行します。
次の表では、「変換」でサポートしているDate関数について説明します。これらと同じ関数が変換APIリファレンス(Groovydoc)で説明されています。
| ユーザー関数 | 戻り値のデータ型 | 説明 |
|---|---|---|
| addTime(Date date, int timeToAdd, String timeUnit) | Date | Dateオブジェクトに時間を追加します。使用する時間単位は、MILLISECONDS、SECONDS、MINUTES、HOURS、DAYS、WEEKS、MONTHSまたはYEARSのいずれかである必要があります。 |
| diffDates(Date firstDate, Date secondDate, String timeUnit) | long | 2つの日付間の差異を特定の時間単位でlongとして計算します。時間単位は、MILLISECONDS、SECONDS、MINUTES、HOURS、DAYS、WEEKS、MONTHSまたはYEARSのいずれかである必要があります。 |
| diffDatesWithPrecision(Date firstDate, Date secondDate, String timeUnit) | double | 2つの日付間の差異を特定の時間単位でdoubleとして計算します。使用する時間単位は、MILLISECONDS、SECONDS、MINUTES、HOURS、DAYS、WEEKS、MONTHSまたはYEARSのいずれかである必要があります。 |
| getDay(Date date, String timeZone, String locale) | int | Dateの日の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| getHour(Date date, String timeZone, String locale) | int | Dateの時の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| getMilliSecond(Date date, String timeZone, String locale) | long | Dateのミリ秒の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| getMinute(Date date, String timeZone, String lcoale) | int | Dateの分の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| getMonth(Date date, String timeZone, String locale) | int | Dateの月の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| getSeconds(Date, String timeZone, String locale) | long | Dateの秒の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| getYear(Date date, String timeZone, String lcoale) | int | Dateの年の値を返します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| today(Date, String timeZone, String locale) | Date | 現在の日付を戻します。タイムゾーンおよびロケールをオプションのパラメータとして指定できます。デフォルト値はそれぞれ、nullおよび"en"です。 |
| truncateDate(Date date, String timeUnit) | Date | 指定した精度でDateを切り捨てます。これは、"seconds"、"minutes"、"hours"、"days"、"months"または"years"のいずれかである必要があります。たとえば、truncateDate(2014/10/31 21:34:56, "months")の場合、2014/10/01 00:00:00を返します。 |
Date定数により、Date関数に渡すことができるデフォルトのDate書式および時間単位を定義します。
| 定数名 | データ型 | 説明 |
|---|---|---|
| DATEFORMAT_DEFAULT | Object | デフォルトの日付書式を定義します: "yyyy/MM/dd HH:mm:ss" |
| DAYS | Object | 日の定数を定義します: "days" |
| HOURS | Object | 時の定数を定義します: "hours" |
| MILLISECONDS | Object | ミリ秒の定数を定義します: "milliseconds" |
| MINUTES | Object | 分の定数を定義します: "minutes" |
| MONTHS | Object | 月の定数を定義します: "months" |
| SECONDS | Object | 秒の定数を定義します: "seconds" |
| WEEKS | Object | 週の定数を定義します: "weeks" |
| YEARS | Object | 年の定数を定義します: "years" |