How to Use the Comparator.comparing Method in Java 8

See Java: Tips and Tricks for similar articles.

The Comparator.comparing method, introduced in Java 8, returns a Comparator object that will use the specified field as the sort key. The Comparator interface is a functional interface in Java 8, and the method implemented is the compare method. Therefore, the compare method is implemented by the comparing method using the specified key. To learn how to use the Comparator.comparing method, follow these seven steps.

  1. Open your text editor and create a new file that will contain the musical instrument class that ultimately will be sorted. Type in the following Java statements:
    public class MusicalInstrument {
    	private String name;
    	private String type;
    	public MusicalInstrument(String name, String type) {
    		setName(name);
    		setType(type);
    	}	
    	public String getName() {
    		return name;
    	}
    	public void setName (String name) {
    		this.name=name;
    	}
    	public String getType() {
    		return type;
    	}
    	public void setType (String type) {
    		this.type=type;
    	}
    	public String toString() {
    		return name + " is a " + type + " instrument";
    	}
    }
    This is a straightforward Java bean that contains two properties: musical instrument name (e.g., trumpet) and type of musical instrument (e.g., brass). I have highlighted the two properties in the image below:Java Source for Musical Instrument
  2. Save your file as MusicalInstrument.java.
  3. Open a command prompt and navigate to the directory containing your new Java program. Then type in the command to compile the source and hit Enter.Compile Source for Musical Instrument
  4. Open your text editor and create the Java program that will demonstrate the use of the Comparator.comparing method. Type in the following Java statements:
    
    import java.util.stream.*;
    import java.util.*;
    public class UseComparatorcomparingMethod {
    	private static List musicalInstruments=new ArrayList<>();
    	static {
    		musicalInstruments.add(new MusicalInstrument("Trumpet","brass"));
    		musicalInstruments.add(new MusicalInstrument("Tuba","brass"));
    		musicalInstruments.add(new MusicalInstrument("Timpani","percussion"));
    		musicalInstruments.add(new MusicalInstrument("Piano","keyboard"));
    	}
    	public static void main (String args[]) {
    		System.out.println("Musical instruments in the collection sorted by name:");
    		Collections.sort(musicalInstruments, Comparator.comparing((MusicalInstrument instrument) -> instrument.getName()));
    		musicalInstruments.stream().forEach(System.out::println);
    		
    		System.out.println("Musical instruments in the collection sorted by type:");
    		Collections.sort(musicalInstruments, Comparator.comparing((MusicalInstrument instrument) -> instrument.getType()));
    		musicalInstruments.stream().forEach(instrument->System.out.println(instrument));
    	}
    }
    The stream will be created from the ArrayList that is defined on line 4. Note that a static block is used to add elements to the ArrayList. A static block is executed one time when the program is loaded into memory. The ArrayList will be sorted by Collections.sort. This static method accepts an ArrayList and a Comparator object. Note that the Comparator object will be returned by the comparing method. The parameter passed to the comparing method is a lambda expression that determines the sort field. The musical instrument name is passed to the first comparing method and the musical instrument type is passed to the second comparing method. I have highlighted the comparing method calls below:Java Source for Comparing Method
  5. Save your file as UseComparatorcomparingMethod.java.
  6. Open a command prompt and navigate to the directory containing your new Java program. Then type in the command to compile the source and hit Enter.Compile Program with Comparing Method
  7. You are ready to test your Java program. Type in the command to run the Java runtime launcher and hit Enter. The output displays the musical instruments sorted first by name and then by type.Run Program with Comparing Method

Related Articles

  1. How to Check Object Type in Java
  2. How to Create a Jar File in Java
  3. How to Compile Packages in Java
  4. How to Throw an Exception in Java
  5. How to Create an Exception Class in Java
  6. How to Use the super Keyword to Call a Base Class Constructor in Java
  7. How to Use the Comparator.comparing Method in Java 8 (this article)
  8. How to Use System.in in Java
  9. How to Call an Interface Method in Java
  10. How to Add a Time Zone in the Java 8 Date/Time API
  11. How to Rethrow an Exception in Java
  12. How to Use the instanceof Operator with a Generic Class in Java
  13. How to Instantiate an Object in Java
  14. How to Filter Distinct Elements from a Collection in Java 8
  15. How to Create a Derived Class in Java
  16. How to Skip Elements with the Skip Method in Java 8
  17. How to Create a Java Bean
  18. How to Implement an Interface in Java
  19. How to Compare Two Objects with the equals Method in Java
  20. How to Set PATH from JAVA_HOME
  21. How to Prevent Race Conditions in Java 8
  22. How to Write a Block of Code in Java
  23. How to Display the Contents of a Directory in Java
  24. How to Group and Partition Collectors in Java 8
  25. How to Create a Reference to an Object in Java
  26. How to Reduce the Size of the Stream with the Limit Method in Java 8
  27. How to Write an Arithmetic Expression in Java
  28. How to Format Date and Time in the Java 8 Date/Time API
  29. How to Use Comparable and Comparator in Java
  30. How to Break a Loop in Java
  31. How to Use the this Keyword to Call Another Constructor in Java
  32. How to Write a Unit Test in Java
  33. How to Declare Variables in Java
  34. How to Override Base Class Methods with Derived Class Methods in Java
  35. How to Use Serialized Objects in Java
  36. How to Write Comments in Java
  37. How to Implement Functional Interfaces in Java 8
  38. How to Write Type Parameters with Multiple Bounds in Java
  39. How to Add Type and Repeating Annotations to Code in Java 8
  40. How to Use Basic Generics Syntax in Java
  41. How to Map Elements Using the Map Method in Java 8
  42. How to Work with Properties in Java
  43. How to Write while and do while Loops in Java
  44. How to Use the finally Block in Java
  45. How to Write for-each Loops in Java
  46. How to Create a Method in Java
  47. How to Continue a Loop in Java
  48. How to Handle Java Files with Streams
  49. How to Create an Interface Definition in Java
  50. How Default Base Class Constructors Are Used with Inheritance