Timestamp.compareTo (日時比較)

  1. 文法
  2. 詳細
  3. 引数
  4. 例外
  5. 戻り値

1. 文法

メンバ型
関数
メンバ所有者
global.Timestamp インスタンス
呼び出し
instance.compareTo( target, fields )

2. 詳細

日時を比較します。比較するフィールド(年月日時分秒曜)を指定すると、対応するフィールドだけが比較対象となります。

3. 引数

target (Timestamp)
比較対象のTimestampオブジェクトを指定します。
fields (String) [default: "YmdHMS"]
比較するフィールドを文字列で指定します。下記のフィールド文字を指定できます。大文字小文字は区別されます。無効な文字は無視されます。
  • Y : 比較対象に「年」を追加します。
  • m : 比較対象に「月」を追加します。
  • d : 比較対象に「日」を追加します。
  • H : 比較対象に「時」を追加します。
  • M : 比較対象に「分」を追加します。
  • S : 比較対象に「秒(整数)」を追加します。
  • s : 比較対象に「秒(実数)」を追加します。
  • A : 比較対象に「曜日」を追加します。

4. 例外

5. 戻り値

比較結果を整数で返します。戻り値と比較結果の関係は以下の通りです。

6. 例

var cmp = ts1.compareTo(ts2); // 年月日時分秒で比較します。
var cmp = ts1.compareTo(ts2, "Ymd"); // 年月日で比較します。