Collator getCollationKey() method in Java with Example

Last Updated : 30 Jul, 2021

The getCollationKey() method of java.text.Collator class is used to get the series of bit converted from string passed into it.

Syntax:

public abstract CollationKey
       getCollationKey(String source)

Parameter: This method accepts the string object as a parameter.
Return Value: This method returns the series of bit converted from the string passed into it.

Below are the examples to illustrate the getCollationKey() method:

Example 1:

Java

// Java program to demonstrate
// getCollationKey() method

import java.text.*;
import java.util.*;
import java.io.*;

public class GFG {
    public static void main(String[] argv)
    {
        try {

            // Creating and initializing
            // new simple rule
            String simple
                = "< a < b < c < d";

            // Creating and initializing
            // new RuleBasedCollator Object
            RuleBasedCollator col
                = new RuleBasedCollator(simple);

            // getting series of bits
            // using getCollationKey() method
            CollationKey key
                = col.getCollationKey("Geek");

            // display result
            System.out.println(
                "Series of bits are :- "
                + key.getSourceString());
        }

        catch (ClassCastException e) {

            System.out.println("Exception thrown : " + e);
        }
        catch (ParseException e) {

            System.out.println("Exception thrown : " + e);
        }
    }
}

Output:

Series of bits are :- Geek

Example 2:

Java

// Java program to demonstrate
// getCollationKey() method

import java.text.*;
import java.util.*;
import java.io.*;

public class GFG {
    public static void main(String[] argv)
    {
        try {

            // Creating and initializing
            // Collator Object
            Collator col
                = Collator.getInstance(Locale.UK);

            // getting series of bits
            // using getCollationKey() method
            CollationKey key
                = col.getCollationKey("CodeBlock");

            // display result
            System.out.println(
                "Series of bits are :- "
                + key.getSourceString());
        }

        catch (ClassCastException e) {

            System.out.println("Exception thrown : " + e);
        }
    }
}