Javaでは値や文字列の大小比較を行うためのメソッドとして「compareTo」メソッドが提供されています。
本記事では、Javaにおける「compareTo」メソッドの基本的な使い方について、サンプルコードをまじえながらご紹介していきたいと思います。
JavaのcompareToメソッドとは
JavaではcompareToメソッドを利用することで値の大小比較を行うことが可能です。
似た機能を持つメソッドとして「equalsメソッド」が存在しますが、equalsメソッドでは比較対象が等しいかどうかを比べるのに対し、「compareToメソッド」ではどちらの値が大きいかもしくは等しいかを結果として返却します。
また、compareToメソッドは基本的には値の大小比較を行うためのメソッドですが、文字列や日付などの大小比較も行うことが可能なため、様々な場面で利用されている便利なメソッドです。
JavaのcompareToメソッドの基本的な使い方を理解しよう
まずは最も基本的な使い方となるcompareToメソッドの使い方をご紹介していきます。
比較対象A.compareTo(比較対象B)
比較対象Aの値が比較対象Bの値よりも大きい場合は「1」、小さい場合は「-1」、同じ場合は「0」が返却されます。
数値の比較
compareToメソッドの中でも最も頻繁に利用される「数値」の比較からサンプルコードで確認していきたいと思います。
import java.util.*;
public class Main {
public static void main(String[] args) throws Exception {
Integer int1 = new Integer(1);
Integer int2 = new Integer(2);
System.out.println(int1.compareTo(int2));
}
}
サンプルコードを実行した結果が下記となります。
-1
サンプルコードではint1の値「1」とint2の値「2」を比較しており、int1の値がint2の値よりも小さいことから「-1」が結果として表示されています。
文字列の比較
文字列の比較を行う場合、2つの対象を比較すること自体は変わりませんが返却される値が異なります。
比較元(左側)の文字コードから比較対象(右側)の文字コードまでの順序差が数値として返却されます。
また比較元の文字コードの方が小さい値の場合には「-(マイナス)」がついた順序差で返却されます。
比較した値が同じ場合には「0」が返却される点は数値や日付の比較と同じです。
数値や日付の比較とは異なりUnicode値の順序差が返却される特徴があります。
import java.util.*;
public class Main {
public static void main(String[] args) throws Exception {
String str1 = "a";
String str2 = "b";
String str3 = "A";
System.out.println(str1.compareTo(str2));
System.out.println(str2.compareTo(str1));
System.out.println(str1.compareTo(str3));
System.out.println(str1.compareToIgnoreCase(str3));
}
}
サンプルコードを実施した結果が下記の通りとなります。
-1 1 32 0
まず1つ目の出力結果に関しては「a」と「b」で比較をしており「a」がUnicode値上「b」よりも1つ小さいため「-1」の値が出力されています。
2つ目の出力に関しては、1つ目の出力結果から比較元と比較対象を入れ替えているため、「-(マイナス)」がない「1」の結果が返却されています。
3つ目の出力は大文字と小文字での比較を行なっており、同じ「a(A)」の値でもUnicode上の値は別物となるため比較元「a」から比較対象「A」の順序差にあたる「32」が返却されています。
最後の4つ目の出力に関しては、compareToIgnoreCaseメソッドを利用しており、大文字と小文字の区別を行わずに比較するメソッドとして提供されています。
3つ目の出力と比較対象自体は同じですが、結果としては「0」が返却されています。
この結果はcompareToIgnoreCaseメソッドにより、大文字と小文字の区別を行わない設定とされたため、同一の文字列として解釈された結果となっています。
日付の比較
日付の比較は前述しました数値の比較や文字列の比較と同じく、システムを作成する上で頻繁に見かける処理の1つです。
日付の比較についてもcompareToメソッドを利用することで実現出来ますのでご紹介していきます。
import java.util.*;
public class Main {
public static void main(String[] args) throws Exception {
Calendar calendar1 = Calendar.getInstance();
Calendar calendar2 = Calendar.getInstance();
calendar1.set(2018, 9, 29, 1, 20, 10);
calendar2.set(2019, 9, 29, 1, 20, 10);
System.out.println(calendar1.compareTo(calendar2));
System.out.println(calendar2.compareTo(calendar1));
System.out.println(calendar1.compareTo(calendar1));
}
}
サンプルコードでは、Calendarクラスを用いて日付の比較を行なっています。
もちろんDateクラスでも比較を行うことは可能ですが、近年の実装では日付処理としてCalendarクラスを利用することの方が多いためサンプルコードとしてもCalendarクラスを用いた比較を検証しています。
サンプルコードを実行した結果が下記となります。
-1 1 0
日付の比較結果は基本的な使い方でご紹介した数値での比較と同じように、比較元の日付が古い場合には「-1」、比較元の日付が新しい場合には「1」、同じ日付の場合には「0」が返却されます。
さいごに
本記事では、Javaの大小比較を行うために利用されるcompareToメソッドの基本的な使い方についてご紹介してきました。
今回ご紹介した内容は基礎的な部分のみとなっており、compareToメソッドを応用して利用することでリストで保持している値を並べ替えるソート処理を実装することなども可能となります。
ぜひ本記事の内容をしっかりと理解して頂いた上で、compareToメソッドを利用した応用パターンについても使いこなせるようなJavaプログラマーを目指してみてください。
文字列の場合は、返却される値が異なりますので後述する「文字列の比較」をご確認ください。