CollationElementIterator reset() method in Java with Examples

The reset() method of java.text.CollationElementIterator class is used to reset the cursor of the iterator to the beginning of the input string.

Syntax:

public void reset()

Parameter: This method does not accept any parameter.
Return Value: This method has nothing to return.

Below is the examples to illustrate the reset() method:

Example 1:

Java

// Java program to demonstrate
// reset() 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 cursor of iterator
        cel.setOffset(2);
        cel.next();

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

        // reset the cursor to the
        // beginning of the string
        // using reset() method
        cel.reset();

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

Output:

current offset before calling reset() 3

current offset after calling reset() 0

Example 2:

Java

// Java program to demonstrate
// reset() 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 cursor of iterator
        cel.setOffset(3);
        cel.previous();

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

        // reset the cursor to the beginning of the string
        // using reset() method
        cel.reset();

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

Output:

current offset before calling reset() 2

current offset after calling reset() 0

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