CollationElementIterator next() method in Java with Examples

The next() method of java.text.CollationElementIterator class is used to get next Collator element. This method push the iterator to the next element and returns its value.

Syntax:

public int next()

Parameter: This method does accepts any parameter.

Return Value: This method returns the value of the next collator element as an integer value.

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

Example 1:

// Java program to demonstrate next() method

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

public class GFG {
    public static void main(String[] argv)
    {
        // creating and initializing testString
        String test = "abcd";

        // creating and initializing
        // RuleBasedCollator object
        RuleBasedCollator rbc
            = (RuleBasedCollator)(Collator.getInstance());

        // creating and initializing
        // CollationElementIterator
        CollationElementIterator cel
            = rbc.getCollationElementIterator(test);

        // setting offset to index 4
        cel.setOffset(1);

        // display the result
        System.out.println("current offset before"
                           + " calling next() "
                           + cel.getOffset());

        // getting offset of the next collator element
        // using next() method
        int value = cel.next();

        // display the result
        System.out.println("\ncurrent element value"
                           + " after calling next() "
                           + value);
    }
}

Output:

current offset before calling next() 1

current element value after calling next() 5439488

Example 2:

// Java program to demonstrate next() method

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

public class GFG {
    public static void main(String[] argv)
    {
        // creating and initializing testString
        String test = "abcd";

        // creating and initializing
        // RuleBasedCollator object
        RuleBasedCollator rbc
            = (RuleBasedCollator)(Collator.getInstance());

        // creating and initializing
        // CollationElementIterator
        CollationElementIterator cel
            = rbc.getCollationElementIterator(test);

        // setting offset to index 4
        cel.setOffset(2);

        // display the result
        System.out.println("current offset before"
                           + " calling next() "
                           + cel.getOffset());

        // getting offset of the next collator element
        // using next() method
        int value = cel.next();

        // display the result
        System.out.println("\ncurrent offset after"
                           + " calling next() "
                           + cel.getOffset());
    }
}

Output:

current offset before calling next() 2

current offset after calling next() 3

Reference: https://docs.oracle.com/javase/9/docs/api/java/text/CollationElementIterator.html#next–