CharacterIterator getBeginIndex() method in Java with Examples

The getBeginIndex() method of java.text.CharacterIterator interface in Java is used to get the index at the beginning that is to be read by this CharacterIterator. This method returns that index number.

Syntax:

public int getBeginIndex()

Parameter: This method do not accept any parameter.

Return Value: This method returns the index number at the beginning that is to be read by this CharacterIterator.

Exception: This method do not throw any Exception.

Program:

// Java program to demonstrate
// the above method

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

public class CharacterIteratorDemo {
    public static void main(String[] args)
    {

        CharacterIterator characterIterator
            = new StringCharacterIterator(
                "GeeksForGeeks");

        System.out.println("BeginIndex: "
                           + characterIterator
                                 .getBeginIndex());
    }
}

Output:

BeginIndex: 0

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