In this post, we feature a comprehensive String CompareTo Java Example. In a previous post, Java Compare Strings Example, we showed how to compare two Strings in java. In that example the test was simple: check if two String objects are equal. But consider the case when you have a collection of Strings and you want to sort it. Of course, equality check is not enough. You have to impose ordering somehow. In strings (words in general), you can use lexicographical ordering.
Lexicographical ordering, or dictionary ordering or alphabetic ordering, is the operation of sorting strings alphabetically as they would appear on a dictionary. The process of doing so is very simple.
Imagining two Strings as an array of characters, then two strings are different if one of the following holds:
- They have a different character in the same position
- They differ in length
- Both of the above
The sorting is done like so:
- Sequentially scanning the strings, find the first (common) position (or index) in which they have a different character.
- Compare the two characters using
'<'or'>'. - The string with the smaller value lexicographically precedes the other.
- If there is no index position at which they have a different characher, then the shorter string lexicographically precedes the longer string.
It is that simple. And it is equally simple to implement that algorithm in Java. But you don’t have to bother as the String class API offers methods that do just that. These methods are compareTo and compareToIngonreCase.
1. String CompareTo Java Example
compareTo will lexicographically compare two strings ad return a negative number if the first string is “smaller” than the second, zero if the strings are equal or a positive number if the first string is “bigger” than the second. Now that returning number is calculated like so:
- If a different character is found in the same position, let it be i, of the two strings the
compareTowill returns1.charaAt(i) - s2.charAt(i). - If there is no index position at which they have a different character,
compareTowill returns1.lenght() - s2.length();
Let’s see how you can use it:
StringCompareToExample.java
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | package com.javacodegeeks.core.lang.string;public class StringCompareToExample { public static void main(String[] args) { String a = "abcd"; String b = "abce"; String c = "abcd"; System.out.println(a.compareTo(b)); System.out.println(c.compareTo(a)); b = "abcde"; System.out.println(a.compareTo(b)); a = "a random string"; b = "another string "; System.out.println(b.compareTo(a)); }} |
The above prints out:
-1
0
-1
78
It is important to note that compareTo compares the strings based on the Unicode value of each character in the strings.
2. Using compareToIgnoreCase
You can use compareToIgnoreCase to lexicographically sort strings without taking case into consideration, e.g for a case-insensitive ordering. Internally it uses : Character.toLowerCase(Character.toUpperCase(character)) to convert all the characters of both strings to lower case.
Let’s see how you can use it:
StringCompareToExample.java
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 | package com.javacodegeeks.core.lang.string;public class StringCompareToExample { public static void main(String[] args) { String st = "abcd"; String st2 = "abce"; String st3 = "aBcE"; System.out.println(st.compareToIgnoreCase(st2)); System.out.println(st.compareToIgnoreCase(st3)); System.out.println(st2.compareToIgnoreCase(st3)); }} |
The above prints out:
-1
-1
0
You can also check the Comparable Java Example to learn more!
3. More articles
4. Download the source code
This was a Java String CompareTo example.
You can download the code of this tutorial here : String CompareTo Java Example
Last updated on May 13th, 2021
