RuleBasedCollator getCollationElementIterator(CharacterIterator) method in Java

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

public CollationElementIterator getCollationElementIterator(CharacterIterator source)

Parameter: This method accepts the character iterator 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
            // StringCharacterIterator Object
            StringCharacterIterator obj
                = new StringCharacterIterator("Geeks");

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

            // 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
            // StringCharacterIterator Object
            StringCharacterIterator obj
                = new StringCharacterIterator("ABCDEF");

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

            // 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.text.CharacterIterator-

RuleBasedCollator getCollationElementIterator(CharacterIterator) method in Java

Explore