Java.lang.StringBuilder.insert() Method



Description

The java.lang.StringBuilder.insert(int dstOffset, CharSequence s, int start, int end) method inserts a subsequence of the specified CharSequence into this sequence.

The subsequence of the argument s specified by start and end are inserted, in order, into this sequence at the specified destination offset, moving up any characters originally above that position. The length of this sequence is increased by end - start.It includes some important points −

  • The dstOffset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
  • The start argument must be nonnegative, and not greater than end.
  • The end argument must be greater than or equal to start, and less than or equal to length of s.

Declaration

Following is the declaration for java.lang.StringBuilder.insert() method

public StringBuilder insert(int dstOffset, CharSequence s, int start, int end)

Parameters

  • dstOffset − This is the offset.

  • s − This is the sequence to be inserted.

  • start − This is the starting index of the subsequence to be inserted.

  • end − This is the end index of the subsequence to be inserted.

Return Value

This method returns a reference to this object.

Exception

IndexOutOfBoundsException − if dstOffset is negative or greater than this.length(), or start or end are negative, or start is greater than end or end is greater than s.length().

Example

The following example shows the usage of java.lang.StringBuilder.insert() method.

package com.tutorialspoint;

import java.lang.*;

public class StringBuilderDemo {

   public static void main(String[] args) {
  
      StringBuilder str = new StringBuilder("tutorials");
      System.out.println("string = " + str);

      CharSequence cSeq = "collection";
      /* insert CharSequence at offset 8 with start index 0 and 
         end index 10 */
      str.insert(8, cSeq, 0, 10);

      // prints StringBuilder after insertion
      System.out.print("After insertion = ");
      System.out.println(str.toString());
   }      
}  

Let us compile and run the above program, this will produce the following result −

string = tutorials
After insertion = tutorialcollections
java_lang_stringbuilder.htm
Advertisements