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

すべてのスーパーインタフェース:
BaseType, java.lang.Comparable<DateType>, Copiable<DateType>, java.io.Serializable

@Rcsid(value="$Revision: 15138 $ $Date: 2009-01-17 02:38:48 +0900 $")
public interface DateType
extends BaseType, java.lang.Comparable<DateType>, Copiable<DateType>

年月日を保持する型。

日付の比較、編集メソッドを持つ。内部に保持する情報は年月日。 この型が保持する情報は年月日であり、それより単位が小さい時間フィールド の情報は初期化される。 つまり、このクラスの利用者は時間フィールドを気にすることなく、 純粋な日付(年月日)のみを比較、または計算した結果を取得することができる。この型の文字列表現はyyyy-MM-dd形式です。

バージョン:
$Revision: 15138 $ $Date: 2009-01-17 02:38:48 +0900 $
作成者:
NTTデータ

メソッドの概要
 DateType add(DateUtil.Calendar field, int amount)
           この日付の日付フィールドに対し、指定された値で加減算を行う。
 DateType add(DateUtil.Calendar field, IntegerType amount)
           この日付の日付フィールドに対し、指定された値で加減算を行う。
 int get(DateUtil.Calendar field)
           この日付の指定フィールドを取得する。
 DateType getFirstDayOfMonth()
           この日付の月初の日付を返す。
 DateType getLastDayOfMonth()
           この日付の月末の日付を返す。
 DateUtil.DayOfWeek getWeek()
           この日付の曜日を返す。
 boolean isAfter(DateType compareDate)
           この日付が、指定した日付より後にあるかどうかを判定する。
 boolean isBefore(DateType compareDate)
           この日付が、指定した日付より前にあるかどうかを判定する。
 boolean isInRange(DateType startDate, DateType endDate, MathUtil.InRange range)
           この日付が、指定された値、境界値条件で範囲内にあるかどうか判定する。
 boolean isOnAndAfter(DateType compareDate)
           この日付が、指定した日付より後にあるかどうかを判定する。
 boolean isOnAndBefore(DateType compareDate)
           この日付が、指定した日付より前にあるかどうかを判定する。
 DateType set(DateUtil.Calendar field, int amount)
           この日付の指定フィールドに対し、指定された値を設定する。
 DateType set(DateUtil.Calendar field, IntegerType amount)
           この日付の指定フィールドに対し、指定された値を設定する。
 
インタフェース jp.finaluna.api.type.BaseType から継承されたメソッド
equals, toStringCode
 
インタフェース java.lang.Comparable から継承されたメソッド
compareTo
 
インタフェース jp.finaluna.api.type.Copiable から継承されたメソッド
deepCopy
 

メソッドの詳細

add

DateType add(DateUtil.Calendar field,
             int amount)

この日付の日付フィールドに対し、指定された値で加減算を行う。

例)日付から5日引く場合は、
 add(DateUtil.DATE, -5);
 

パラメータ:
field - 日付フィールド
amount - 加減算する値
戻り値:
加減算を行った日付型

add

DateType add(DateUtil.Calendar field,
             IntegerType amount)

この日付の日付フィールドに対し、指定された値で加減算を行う。

パラメータ:
field - 日付フィールド
amount - 加減算する値
戻り値:
加減算を行った日付型

getFirstDayOfMonth

DateType getFirstDayOfMonth()

この日付の月初の日付を返す。

戻り値:
この日付の月初の日付

getLastDayOfMonth

DateType getLastDayOfMonth()

この日付の月末の日付を返す。

戻り値:
この日付の月末の日付

getWeek

DateUtil.DayOfWeek getWeek()

この日付の曜日を返す。

戻り値:
この日付の曜日

isAfter

boolean isAfter(DateType compareDate)

この日付が、指定した日付より後にあるかどうかを判定する。

compareDateNULL 値の場合、 false を返却。

パラメータ:
compareDate - 比較対象日付
戻り値:
比較対象日付より後にある場合、true
比較対象日付より前にある場合、false
比較対象日付と同じ場合、false

isBefore

boolean isBefore(DateType compareDate)

この日付が、指定した日付より前にあるかどうかを判定する。

compareDateNULL 値の場合、 false を返却。

パラメータ:
compareDate - 比較対象日付
戻り値:
比較対象日付より前にある場合、true
比較対象日付より後にある場合、false
比較対象日付と同じ場合、false

isInRange

boolean isInRange(DateType startDate,
                  DateType endDate,
                  MathUtil.InRange range)

この日付が、指定された値、境界値条件で範囲内にあるかどうか判定する。

開始日付、終了日付の境界値条件は、rangeに指定された境界値条件に従う。

パラメータ:
startDate - 開始日付
endDate - 終了日付
range - 境界値条件
戻り値:
指定された値が境界値条件で範囲内にある場合、true
それ以外の場合、 false

isOnAndAfter

boolean isOnAndAfter(DateType compareDate)

この日付が、指定した日付より後にあるかどうかを判定する。

compareDateNULL 値の場合、 false を返却。

パラメータ:
compareDate - 比較対象日付
戻り値:
比較対象日付より後にある場合、true
比較対象日付より前にある場合、false
比較対象日付と同じ場合、true

isOnAndBefore

boolean isOnAndBefore(DateType compareDate)

この日付が、指定した日付より前にあるかどうかを判定する。

compareDateNULL 値の場合、 false を返却。

パラメータ:
compareDate - 比較対象日付
戻り値:
比較対象日付より前にある場合、true
比較対象日付より後にある場合、false
比較対象日付と同じ場合、true

set

DateType set(DateUtil.Calendar field,
             int amount)

この日付の指定フィールドに対し、指定された値を設定する。

例)日付に1日を設定する。
 set(DateUtil.DATE, 1);
 

Note:
月フィールドは、1月を0から数え、12月を11として扱います。

パラメータ:
field - 日付フィールド
amount - 設定する値
戻り値:
設定した日付型

set

DateType set(DateUtil.Calendar field,
             IntegerType amount)

この日付の指定フィールドに対し、指定された値を設定する。

パラメータ:
field - 日付フィールド
amount - 設定する値
戻り値:
設定した日付型

get

int get(DateUtil.Calendar field)

この日付の指定フィールドを取得する。

パラメータ:
field - 日付フィールド
戻り値:
指定したフィールドの値