StringCharacterIterator getBeginIndex() method in Java with Examples

The getBeginIndex() method of java.text.StringCharacterIterator class in Java is used to get the index at the beginning that is to be read by this StringCharacterIterator. 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 at the beginning that is to be read by this StringCharacterIterator.

Exception: This method do not throw any Exception.

Program:

// Java program to demonstrate
// the above method

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

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

        StringCharacterIterator
            stringCharacterIterator
            = new StringCharacterIterator(
                "GeeksForGeeks");

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

Output:

Current BeginIndex: 0

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