Java - String offsetByCodePoints() Method

The Java string offsetByCodePoints() method returns the index within the given string that is offset from the given index by codePointOffset code points.

Syntax

public int offsetByCodePoints(int index,
                              int codePointOffset)

Parameters

Return Value

Returns the index within the given string.

Exception

Throws IndexOutOfBoundsException, if index is negative or larger then the length of the String, or if codePointOffset is positive and the substring starting with index has fewer than codePointOffset code points, or if codePointOffset is negative and the substring before index has fewer than the absolute value of codePointOffset code points.

Example:

In the example below, offsetByCodePoints() method returns the index within the given string which is offset from the given index by specified codePointOffset code points.

import java.lang.*;

public class MyClass {
  public static void main(String[] args) {
    String MyString = "Hello World!.";
    
    //returns the index within the string
    int val = MyString.offsetByCodePoints(3, 5);
    System.out.println("index = " + val); 
  }
}

The output of the above code will be:

index = 8