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

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

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

時分秒を保持する型。

時刻の比較、編集メソッドを持つ。 内部に保持する情報は時分秒。年月日の値は、Java.util.Calendarクラスの基準時間を保持する。 この型が保持する情報は時刻フィールドであり、それより単位が大きい日付フィールド の情報は初期化される。 つまり、このクラスの利用者は日付フィールドを気にすることなく、 純粋な時刻(時分秒)のみを比較、または計算した結果を取得することができる。この型の文字列表現はHH:mm:ssです。

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

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

メソッドの詳細

add

TimeType add(DateUtil.Calendar field,
             int amount)

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

例)時刻から10時間足す場合は、
 add(DateUtil.HOUR_OF_DAY, 10);
 

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

add

TimeType add(DateUtil.Calendar field,
             IntegerType amount)

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

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

isAfter

boolean isAfter(TimeType compareTime)

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

compareTimeNULL 値の場合、 false を返却。

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

isBefore

boolean isBefore(TimeType compareTime)

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

compareTimeNULL 値の場合、 false を返却。

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

isInRange

boolean isInRange(TimeType startTime,
                  TimeType endTime,
                  MathUtil.InRange range)

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

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

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

isOnAndAfter

boolean isOnAndAfter(TimeType compareTime)

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

compareTimeNULL 値の場合、 false を返却。

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

isOnAndBefore

boolean isOnAndBefore(TimeType compareTime)

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

compareTimeNULL 値の場合、 false を返却。

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

set

TimeType set(DateUtil.Calendar field,
             int amount)

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

例)時刻に22時を設定する。
 set(DateUtil.HOUR_OF_DAY, 22);
 

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

set

TimeType set(DateUtil.Calendar field,
             IntegerType amount)

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

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

get

int get(DateUtil.Calendar field)

この時刻の指定フィールドを取得する。

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