Java String offsetByCodePoints​() Method Example


Quick guide to Java String API offsetByCodePoints​() Method With Example. Syntax: public int offsetByCodePoints​(int index, int codePointOffset)

1. Java String offsetByCodePoints​() Method Overview

offsetByCodePoints​() method returns the index within this String that is offset from the given index by codePointOffset code points.
Unpaired surrogates within the text range given by index and codePointOffset count as one code point each.

Java String API offsetByCodePoints​() Method Example

1.1 Syntax

Here is the full syntax for this method and part of java.lang package.

public int offsetByCodePoints​(int index, int codePointOffset)

Article on Java Package

More Articles on Java String API.

Java String offsetByCodePoints​()

1.2 Parameters

index: the index to be offset
codePointOffset: the offset in code poi

1.3 Returns


the index within this String

1.4 Throws

IndexOutOfBoundsException - if index is negative or larger then the length of this String.

1.5 Since

Java 1.5

2. String offsetByCodePoints​() Method Examples

We will write a example program on offsetByCodePoints​ method.

String blogName = "java-w3schools blog is a Googles blog";
int offsetIndex = blogName.offsetByCodePoints(3, 5);
System.out.println("Input String : "+blogName);
System.out.println("offset index : " + offsetIndex);


Input String : java-w3schools blog is a Googles blog
offset index : 8

3. IndexOutOfBoundsException

This method throws run time exception if the index is negative or more than string length.

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.

See the below code where passing index is more than it's length. We should see abnormal when execute this program.

int offsetIndex2 = blogName.offsetByCodePoints(30, 100);

Expected exception stack trace:

Exception in thread "main" java.lang.IndexOutOfBoundsException
 at java.base/java.lang.Character.offsetByCodePoints(Character.java:8929)
 at java.base/java.lang.String.offsetByCodePoints(String.java:829)
 at com.java.w3schools.blog.string.StringOffsetByCodePoints.main(StringOffsetByCodePoints.java:18)

4. offsetByCodePoints​() Internal Code

Let us take a look this method api internal code and how it is implemented.

public int offsetByCodePoints(int index, int codePointOffset) {
    if (index < 0 || index > length()) {
        throw new IndexOutOfBoundsException();
    return Character.offsetByCodePoints(this, index, codePointOffset);

Step 1: First, does validation on passed parameters. That is index should not be negative and not more than this string.
Step 2: Calls Character.offsetByCodePoints(this, index, codePointOffset) by passing current string, index and codePointOffset values. Character.offsetByCodePoints() method returns index.

5. Conclusion

In this quick tutorial, We've seen example program on "Java String API offsetByCodePoints​() Method" and when it will throw runtime exception if index is not in it's limits.

And also seen how offsetByCodePoints() method works internally.

Example code snippets shown in this article is available on GitHub.



About Us

Author: Venkatesh - I love to learn and share the technical stuff.

accumulo,1,ActiveMQ,2,Adsense,1,API,37,ArrayList,18,Arrays,24,Bean Creation,3,Bean Scopes,1,BiConsumer,1,Blogger Tips,1,Books,1,C Programming,1,Collection,8,Collections,37,Collector,1,Command Line,1,Comparator,1,Compile Errors,1,Configurations,7,Constants,1,Control Statements,8,Conversions,6,Core Java,149,Corona India,1,Create,2,CSS,1,Date,3,Date Time API,38,Dictionary,1,Difference,2,Download,1,Eclipse,3,Efficiently,1,Error,1,Errors,1,Exceptions,8,Fast,1,Files,17,Float,1,Font,1,Form,1,Freshers,1,Function,3,Functional Interface,2,Garbage Collector,1,Generics,4,Git,9,Grant,1,Grep,1,HashMap,2,HomeBrew,2,HTML,2,HttpClient,2,Immutable,1,Installation,1,Interview Questions,6,Iterate,2,Jackson API,3,Java,32,Java 10,1,Java 11,6,Java 12,5,Java 13,2,Java 14,2,Java 8,128,Java 8 Difference,2,Java 8 Stream Conversions,4,java 8 Stream Examples,12,Java 9,1,Java Conversions,14,Java Design Patterns,1,Java Files,1,Java Program,3,Java Programs,114,Java Spark,1,java.lang,4,java.util. function,1,JavaScript,1,jQuery,1,Kotlin,11,Kotlin Conversions,6,Kotlin Programs,10,Lambda,2,lang,29,Leap Year,1,live updates,1,LocalDate,1,Logging,1,Mac OS,3,Math,1,Matrix,6,Maven,1,Method References,1,Mockito,1,MongoDB,3,New Features,1,Operations,1,Optional,6,Oracle,5,Oracle 18C,1,Partition,1,Patterns,1,Programs,1,Property,1,Python,2,Quarkus,1,Read,1,Real Time,1,Recursion,2,Remove,2,Rest API,1,Schedules,1,Serialization,1,Servlet,2,Sort,1,Sorting Techniques,8,Spring,2,Spring Boot,23,Spring Email,1,Spring MVC,1,Streams,31,String,61,String Programs,28,String Revese,1,StringBuilder,1,Swing,1,System,1,Tags,1,Threads,11,Tomcat,1,Tomcat 8,1,Troubleshoot,26,Unix,3,Updates,3,util,5,While Loop,1,
JavaProgramTo.com: Java String offsetByCodePoints​() Method Example
Java String offsetByCodePoints​() Method Example
Quick guide to Java String API offsetByCodePoints​() Method With Example. Syntax: public int offsetByCodePoints​(int index, int codePointOffset)
Loaded All Posts Not found any posts VIEW ALL Readmore Reply Cancel reply Delete By Home PAGES POSTS View All RECOMMENDED FOR YOU LABEL ARCHIVE SEARCH ALL POSTS Not found any post match with your request Back Home Sunday Monday Tuesday Wednesday Thursday Friday Saturday Sun Mon Tue Wed Thu Fri Sat January February March April May June July August September October November December Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec just now 1 minute ago $$1$$ minutes ago 1 hour ago $$1$$ hours ago Yesterday $$1$$ days ago $$1$$ weeks ago more than 5 weeks ago Followers Follow THIS PREMIUM CONTENT IS LOCKED STEP 1: Share to a social network STEP 2: Click the link on your social network Copy All Code Select All Code All codes were copied to your clipboard Can not copy the codes / texts, please press [CTRL]+[C] (or CMD+C with Mac) to copy Table of Content