RuleBasedCollator getCollationElementIterator(String) method in Java

The getCollationElementIterator() method of java.text.RuleBasedCollator class is used to get the object of collation element iterator for the given string. 

Syntax:

public CollationElementIterator
       getCollationElementIterator(String source)

Parameter: This method accepts the string object as a parameter. 

Return Value: This method returns the object of collation element iterator for the given string. 

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

Example 1:

Java

// Java program to demonstrate
// getCollationElementIterator() 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);

            // Creating and initializing
            // the String Object
            String str = "ABABCC";

            // getting CollationElementIterator Object
            // for the given String
            // using getCollationElementIterator() method
            CollationElementIterator key
                = col.getCollationElementIterator(str);

            // display result
            System.out.println("CollationElementIterator is : "
                               + key);
        }

        catch (ClassCastException e) {

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

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

Output:

CollationElementIterator is : java.text.CollationElementIterator@7d4991ad

Example 2:

Java

// Java program to demonstrate
// getCollationElementIterator() 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 & a < c";

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

            // Creating and initializing the String Object
            String str = "GEeks";

            // getting CollationElementIterator Object
            // for the given String
            // using getCollationElementIterator() method
            CollationElementIterator key
                = col.getCollationElementIterator(str);

            // display result
            System.out.println("CollationElementIterator is : "
                               + key);
        }

        catch (ClassCastException e) {

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

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

Output:

CollationElementIterator is : java.text.CollationElementIterator@7d4991ad

Reference: https://docs.oracle.com/javase/9/docs/api/java/text/RuleBasedCollator.html#getCollationElementIterator-java.lang.String-