CollationElementIterator getOffset() method in Java with Examples

The getOffset() method of java.text.CollationElementIterator class is used to get the index of item present at collator currently pointed by CollationElementIterator.

Syntax:

public int getOffset()

Parameter: This method does not accept any parameter.

Return Value: This method returns the offset of element currently pointed by iterator.

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

Example 1:

// Java program to demonstrate getOffset() 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 = "Code Geeks 123";

        // 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(4);

        // getting offset of cel
        // using getOffset() method
        int value = cel.getOffset();

        // display the result
        System.out.println("current offset is "
                           + value);
    }
}

Output:

current offset is 4

Example 2:

// Java program to demonstrate getOffset() 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 = "Code Geeks 123";

        // 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(4);

        // calling next element
        cel.next();

        // getting offset of cel
        // using getOffset() method
        int value = cel.getOffset();

        // display the result
        System.out.println("current offset is "
                           + value);
    }
}

Output:

current offset is 5

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