com.nttdocomo.util
クラス ScheduleDate

Object
  com.nttdocomo.util.ScheduleDate

public class ScheduleDate

extends Object

スケジュールの時刻を指定するためのクラスです。

このクラスは、 スケジューラの設定や iアプリケーションの自動起動設定 に使用され、 スケジュール時刻や自動起動時刻の内容を保持します。

日時指定のタイプとして、 「1回限り」 「毎日」 「毎週」 「毎月」 「毎年」のスケジュール時刻を設定できます。

「毎月」の日時指定タイプの場合、日と時刻を指定できますが、 月によってはその月の日数を超えた日となってしまうことがあります (「毎月31日」を指定した場合の2月や4月など)。 その場合に、当該月でイベントが発生するか否か、 発生する場合にいつに発生するかは機種依存です。
「毎年」の日時指定タイプの場合の、うるう年の扱いも、 同様に機種依存です。

このクラスで提供されている set(int, int) や get(int) は、 Calendar.DAY_OF_WEEK フィールドを設定する場合を除いては、 set(java.util.Calendar.DATE, 40) のように範囲外の値を設定した場合の振る舞いも含めて、 java.util.Calendar クラスの同名のメソッドと同じ振る舞いをします。

導入されたバージョン:

DoJa-3.0 (505i)

関連項目:

Schedule, IApplication

フィールドの概要

static int	DAILY 「毎日」のスケジュール時刻を表す日時指定タイプです(=0x02)。
static int	MONTHLY 「毎月」のスケジュール時刻を表す日時指定タイプです(=0x08)。
static int	ONETIME 「1回限り」のスケジュール時刻を表す日時指定タイプです(=0x01)。
static int	WEEKLY 「毎週」のスケジュール時刻を表す日時指定タイプです(=0x04)。
static int	YEARLY 「毎年」のスケジュール時刻を表す日時指定タイプです(=0x10)。

コンストラクタの概要

ScheduleDate(int type)
日時指定タイプを指定して、オブジェクトを生成します。

メソッドの概要

int	get(int field) スケジュール時刻の日時を取得します。
int	getType() スケジュール時刻の日時指定タイプを取得します。
void	set(int field, int value) スケジュール時刻の日時を設定します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

ONETIME

public static final int ONETIME

「1回限り」のスケジュール時刻を表す日時指定タイプです(=0x01)。

関連項目:

定数フィールド値

DAILY

public static final int DAILY

「毎日」のスケジュール時刻を表す日時指定タイプです(=0x02)。

関連項目:

定数フィールド値

WEEKLY

public static final int WEEKLY

「毎週」のスケジュール時刻を表す日時指定タイプです(=0x04)。

関連項目:

定数フィールド値

MONTHLY

public static final int MONTHLY

「毎月」のスケジュール時刻を表す日時指定タイプです(=0x08)。

関連項目:

定数フィールド値

YEARLY

public static final int YEARLY

「毎年」のスケジュール時刻を表す日時指定タイプです(=0x10)。

関連項目:

定数フィールド値

コンストラクタの詳細

ScheduleDate

public ScheduleDate(int type)

日時指定タイプを指定して、オブジェクトを生成します。 日時の値は、現在の日付および時刻 (System.currentTimeMillis()の戻り値および標準のタイムゾーン) を元に設定されます。 例えば、このコンストラクタを呼び出したのが2003年1月23日 5時6分であり、 日時指定タイプにMONTHLYが指定された場合、 毎月23日の5時6分のスケジュール時刻を表すように設定されます。

パラメータ:

type - 日時指定タイプを指定します。 ONETIME、 DAILY、 WEEKLY、 MONTHLY、 YEARLY のいずれかを指定します。

例外:

IllegalArgumentException - 引数 type に不正な値を指定した場合に発生します。

メソッドの詳細

getType

public int getType()

スケジュール時刻の日時指定タイプを取得します。

戻り値:

日時指定タイプを返します。 ONETIME、 DAILY、 WEEKLY、 MONTHLY、 YEARLY のいずれかが返ります。

get

public int get(int field)

スケジュール時刻の日時を取得します。

引数 field に指定できる値と得られる値については、 setメソッドを参照してください。

パラメータ:

field - 取得する要素を指定します。

戻り値:

設定値を返します。

例外:

IllegalArgumentException - 引数 field に不正な値を指定した場合に発生します。

set

public void set(int field,
                int value)

スケジュール時刻の日時を設定します。

日時指定タイプがONETIMEの場合

引数 field には、 java.util.CalendarクラスのYEAR、MONTH, DATE(DAY_OF_MONTH)、 HOUR_OF_DAY、MINUTEが指定可能です。

日時指定タイプがDAILYの場合

引数 field には、 java.util.CalendarクラスのHOUR_OF_DAY、MINUTEが指定可能です。

日時指定タイプがWEEKLYの場合

引数 field には、 java.util.CalendarクラスのDAY_OF_WEEK、HOUR_OF_DAY、MINUTEが指定可能です。

日時指定タイプがMONTHLYの場合

引数 field には、 java.util.CalendarクラスのDATE(DAY_OF_MONTH)、HOUR_OF_DAY、MINUTEが指定可能です。

日時指定タイプがYEARLYの場合

引数 field には、 java.util.CalendarクラスのMONTH, DATE(DAY_OF_MONTH)、 HOUR_OF_DAY、MINUTEが指定可能です。

引数valueに指定できる値は、引数fieldの値に依存し、 java.util.Calendarクラスのset(int field, int value)メソッドと同じです。

パラメータ:

field - 設定する要素を指定します。

value - 設定する値を指定します。

例外:

IllegalArgumentException - 引数 field に不正な値を指定した場合に発生します。

IllegalArgumentException - 引数 field に Calendar.DAY_OF_WEEK が指定されているにもかかわらず、 引数 value が Calendar クラスに定義されている曜日を表すフィールドのいずれでもない場合 に発生します。