Java Comparable Representative For Natural Club Sorting

Java allows you lot to variety your object inwards natural gild past times implementing Comparable interface. It's ane of the telephone commutation interface of Java API together with defined inwards java.lang package, which way you lot don't require to implement this dissimilar its counterpart Comparator, which is defined inwards java.util package.  Comparable is used to supply natural gild of sorting to objects e.g. numeric gild is natural gild for numbers, alphabetic gild is natural gild for String together with chronological gild is natural for dates. Similarly when you lot define your ain objects e.g. Person, sorting it on advert sounds natural. Similarly for teams, ranking seems their natural orders. It all depends how object is looked inwards their domain.

By the way, you lot are non express to only ane order, you lot tin variety objects inwards whatsoever gild past times using java.util.Comparator, every bit nosotros own got seen inwards our finally article custom sorting inwards Java.

Comparable interface defines abstract method compareTo(), you lot require to override this method to implement natural gild sorting of objects inwards Java. This method returns positive if the object, on which you lot are calling this method is greater than other object, render negative, if this object is less than other together with returns null if both object are equal.

Several other classes from Java API relies on this interface for their behavior, for instance Arrays.sort(), Collections.sort() uses this method to variety objects contained inwards Array together with Collection inwards their natural order. Similarly SortedSet together with SortedMap implementation e.g. TreeSet and TreeMap also uses compareTo() method to snuff it along their elements sorted.

I own got before shared some tips to override compareTo() method, which is every bit good worth looking if you lot are implementing Comparable interface. In this article, nosotros volition encounter a uncomplicated instance of Java Comparable interface, to variety objects inwards their natural order.

Comparable together with compareTo Method

Comparable has alone ane method compareTo(), which is where nosotros define logic to compare objects. As I said inwards previous paragraph that this method returns positive, negative together with null depending upon number of comparison, but most of import thing, in that place is no restriction on render 1, 0 or -1 for greater, equal together with lesser results, you lot tin render whatsoever positive or negative number, this holding is utilized inwards this example, but it comes alongside caveat that divergence betwixt them should non exceed, Integer.MAX_VALUE, good explained inwards my favorite mass equals() method. Though this is non a requirement mandated past times compiler or Java API, together with in that place are examples of violating this regulation inwards Java API itself e.g. BigDecimal, you lot should brand them consistent if you lot are going to shop object inwards SortedSet or SortedMap. Failing to practise so, volition number inwards classes similar Set breaking their invariant together with allowing duplicates.

One to a greater extent than of import affair to recollect is gild of comparison, if your object contains multiple value fields together with thence the gild on which you lot compare is important, compare them from most useful to to the lowest degree useful. This is where it differs alongside equals, inwards that you lot don't require to set attending on gild of comparison, though comparing primitives before is preferred due to performance reason, but hither it affects your sorting order. If you lot are comparing objects, together with thence telephone weep upwards their respective compareTo() methods, don't reinvent comparison. Last but non the to the lowest degree Prefer relational operator over arithmetics operator for comparing numeric fields. I every bit good recommend to read corresponding special on Effective Java for to a greater extent than deeper agreement of this useful concept together with don't forget to read about difference betwixt Comparable together with Comparator interface before going to whatsoever Java interview.

Java Comparable Example

Here is our code instance of how to implement Comparable interface inwards Java.  This code is saved inwards a Java file called HelloComparable.java, but it contains 2 classes, kickoff HelloComparable, which is a show shape to demonstrate example, together with instant shape named Bank, which is our domain object. Banks has only 2 fields, advert together with ranking. In this example, I own got taken their ranking every bit natural order, but inwards  some cases it may good live on their advert every bit well.  Point hither is whatever logic you lot set on compareTo() method, that becomes your natural order, thence you lot should set the logic which is most mutual inwards your application e.g. sorting Employee objects on id is most common, together with sorting Event object on appointment is most common. If you lot aspect at code of compareTo() method it only does an integer arithmetics together with render number its possible because ranking are pocket-sized positive number. It makes your code clean, but alone if you lot are 100% certain that divergence volition non overstep maximum value of integer inwards product's life time, because it it happens it volition create subtle bugs due to integer overflow, giving impression that your natural gild sorting is working inwards many cases but of a abrupt fails. By the way, I would similar to percentage debugging tips alongside such condition, if you lot e'er human face upwards an issue, which is intermittent, focus on information together with concurrency. Repeat show alongside same information together with if you lot are non able to reproduce than focus on concurrency feature of application. Coming banking concern to our Comparable example, nosotros own got stored all half dozen banks inwards random gild inwards a List together with using Collections.sort() method to variety them on their natural order. This is an overloaded method, where other version every bit good hold back Comparator for custom gild sorting. You tin every bit good role Arrays.sort() method, if you lot prefer to shop your object inwards array. Both Collections.sort() together with Arrays.sort() variety objects inwards their natural order, defined by compareTo() method of java.lang.Comaprable interface.

import java.util.ArrayList; import java.util.Collections; import java.util.List;  public class HelloComparable {      public static void main(String args[]) {         Bank citibank = new Bank("Citibank", 1);         Bank icici = new Bank("ICICI", 5);         Bank bankOfAmerica = new Bank("BankOfAmerica", 2);         Bank dbs = new Bank("DBS", 6);         Bank hsbc = new Bank("HSBC", 3);         Bank scb = new Bank("Standard Charted", 4);          List<Bank> banks = new ArrayList<Bank>();         banks.add(citibank);         banks.add(icici);         banks.add(bankOfAmerica);         banks.add(dbs);         banks.add(hsbc);         banks.add(scb);          // impress banks inwards unsorted order         System.out.println("List of Banks inwards unsorted order" + banks);          // Sort banking concern on their natural order, which is ranking         Collections.sort(banks);          // impress banks inwards their natural order, sorted         System.out.println("List of Banks inwards sorted order" + banks);     } }  class Bank implements Comparable<Bank> {      private String name;     private int ranking;      public Bank(String name, int ranking) {         this.name = name;         this.ranking = ranking;     }      @Override     public int compareTo(Bank bank) {         return this.ranking - bank.ranking; // possible because ranking is small         // positive integer     }      @Override     public int hashCode() {         final int prime number = 31;         int number = 1;         number = prime number * number + ((name == null) ? 0 : name.hashCode());         number = prime number * number + ranking;         return result;     }      @Override     public boolean equals(Object obj) {         if (this == obj) {             return true;         }         if (obj == null) {             return false;         }         if (getClass() != obj.getClass()) {             return false;         }         Bank other = (Bank) obj;         if (name == null) {             if (other.name != null) {                 return false;             }         } else if (!name.equals(other.name)) {             return false;         }         if (ranking != other.ranking) {             return false;         }         return true;     }      @Override     public String toString() {         return String.format("%s: %d", name, ranking);     }  }  Output: List of Banks inwards unsorted order[Citibank: 1, ICICI: 5, BankOfAmerica: 2, DBS: 6, HSBC: 3, Standard Charted: 4] List of Banks inwards sorted order[Citibank: 1, BankOfAmerica: 2, HSBC: 3, Standard Charted: 4, ICICI: 5, DBS: 6]

That's all inwards this Java Comparable example. Always recollect to brand your compareTo() method consistent alongside equals, alone role integer arithmetics functioning inwards compareTo if you lot know numbers are positive together with small, together with their divergence volition non overstep maximum value of integer inwards Java. You should implement Comparable interface for all value or domain classes e.g. Order, Trade, Instrument, Security, Counterparty etc .

Further Learning
Java In-Depth: Become a Complete Java Engineer
Java Fundamentals: Collections
Data Structures together with Algorithms: Deep Dive Using Java
Algorithms together with Data Structures - Part 1 together with 2
Data Structures inwards Java ix past times Heinz Kabutz

Share this post