CharacterIterator setIndex() method in Java with Examples

The setIndex() method of java.text.CharacterIterator interface in Java is used to set the current index that is to be read by this CharacterIterator. This method takes the index to be set as a parameter and sets the index of this CharacterIterator at that index and then it returns that character. Syntax:

public char setIndex(int index)

Parameter: This method takes the index to be set as a parameter and sets the index of this CharacterIterator. Return Value: This method returns the character at the index set by this method. Exception: This method throw IllegalArgumentException if the specified index is not in the valid range (getBeginIndex(), getEndIndex() - 1). Program: Java

// 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("Current Index: "
                           + characterIterator
                                 .getIndex());

        int index = 5;

        System.out.println("Updated the index to : "
                           + index);

        System.out.println("Character at new"
                           + " current index: "
                           + characterIterator
                                 .setIndex(index));
    }
}

Reference: https://docs.oracle.com/javase/9/docs/api/java/text/CharacterIterator.html#setIndex-int-