Dartで使われる「compareToメソッド」について解説します。
compareToメソッドとは
「compareToメソッド」は、同じ型の値を比較し、その結果に合わせた値を返すメソッドです。
イメージとしては、次のようになっています。
a.compareTo (T b) {
//aがbより大きければ1を返す
if (a > b) {
return 1;
}
//aがbより小さければ-1を返す
if (a < b) {
return -1;
}
//等しければ0を返す
return 0
}
引数の「T」は、「int」や「String」のような型です。
このメソッドは、比較の結果を「true」や 「false」ではなく、「１」、「０」、「−１」で表現するのがポイントです。
また、メソッドなので、使用する際は、「.compareTo()」のようにドット(.)でアクセスします。
上記のcompareToの定義は、私が書き換えたものです。
ちゃんとした定義を知りたいという人は、下記の公式ドキュメントを参照してください。
compareTo method - Comparable class - dart:core library - Dart API
API docs for the compareTo method from the Comparable class, for the Dart programming language.
api.dart.dev
まとめ
compareToメソッドは、引数に指定した値を比較し、結果に合わせて数値を返すメソッドです。
値を比較する際に役立つメソッドです。
参考
Alberto Miola, Flutter Complete Reference.（書籍）
compareTo method - Comparable class - dart:core library - Dart API
API docs for the compareTo method from the Comparable class, for the Dart programming language.
api.dart.dev
コメント