StringCharacterIterator equals() method in Java with Examples

The equals() method of java.text.StringCharacterIterator class in Java is used to check for equality of this StringCharacterIterator with the specified StringCharacterIterator. This method takes a StringCharacterIterator instance and compares it with this StringCharacterIterator and returns a boolean value representing the same.

Syntax:

public boolean equals(Object obj)

Parameter: This method accepts a parameter obj which is the StringCharacterIterator to be checked for equality with this StringCharacterIterator.

Return Value: This method returns an boolean which tells if this StringCharacterIterator is equal to the specified Object.

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 sci1
            = new StringCharacterIterator(
                "GeeksforGeeks");

        System.out.println("StringCharacterIterator 1: "
                           + sci1);

        StringCharacterIterator sci2
            = new StringCharacterIterator(
                "Geeks for Geeks");

        System.out.println("StringCharacterIterator 2: "
                           + sci2);

        StringCharacterIterator sci3
            = (StringCharacterIterator)sci1
                  .clone();

        System.out.println("StringCharacterIterator 3: "
                           + sci3);

        System.out.println("Comparing DFS 1 and DFS 2: "
                           + sci1.equals(sci2));

        System.out.println("Comparing DFS 2 and DFS 3: "
                           + sci2.equals(sci3));

        System.out.println("Comparing DFS 1 and DFS 3: "
                           + sci1.equals(sci3));
    }
}

Output:

StringCharacterIterator 1: java.text.StringCharacterIterator@bd43b778
StringCharacterIterator 2: java.text.StringCharacterIterator@ac5740a8
StringCharacterIterator 3: java.text.StringCharacterIterator@bd43b778
Comparing DFS 1 and DFS 2: false
Comparing DFS 2 and DFS 3: false
Comparing DFS 1 and DFS 3: true

Reference: https://docs.oracle.com/javase/9/docs/api/java/text/StringCharacterIterator.html#equals-java.lang.Object-