RuleBasedCollator getCollationElementIterator(String) method in Java

The java.text.RuleBasedCollator class has getCollationElementIterator() function. The object of the collation element iterator for the supplied String is obtained using the RuleBasedCollator class.

Syntax:

Parameter: The string object is a parameter that this method takes.

Return Value: The object of the collation element iterator for the supplied String is returned by this method.

Example 1:

For a given string, the code illustrates how to create a CollationElementIterator using RuleBasedCollator. The characters 'x', 'y', 'z', and 'd' are sorted in the order specified by the custom collation rule "< x < y < z < d" that is defined. This rule creates an instance of a RuleBasedCollator object, and its getCollationElementIterator() function receives the string "XYZXZZ". The result of this method is a CollationElementIterator that separates the String into distinct collation items for analysis. In order to handle ClassCastException and ParseException in the event that the rule or objects are invalid, exception handling is present.

Implementation:

FileName: GetCollationExample1.java

Output:

 The CollationElementIterator is given by : java.text.CollationElementIterator@6f94fa3e 

Example 2:

For string comparison, the code generates a custom collation rule "< x < y < z < d" using RuleBasedCollator. This rule generates a RuleBasedCollator object and passes the string "Hello World" to the getCollationElementIterator() function. The result of this method is a CollationElementIterator that divides the String into collation elements in accordance with the specified rule. Characters like "H," "e," and "W," however, are not particularly treated by the rule, which only specifies the order for "x," "y," "z," and "d." As a result, the iterator processes them in their default order. In the event that an object type or rule specification is incorrect, exception handling for ClassCastException and ParseException is provided.

Implementation:

FileName: GetCollationExample2.java

Output:

 The CollationElementIterator is given by : java.text.CollationElementIterator@6f94fa3e