copy() in Java

Introduction to copy() in Java

In Java, while using collections we come across various scenarios to copy the elements of one list into the other with a precaution that index of elements must not be affected while copying. For such type of scenarios, java.util.Collections package provides us with a function copy() that copies elements present in one list into the other list, such that elements have the same index in the new list as well. While using this function, the size of the destination list must be greater than the size of the source list. This time complexity of this function is linear.

Syntax with Parameters

Following is a syntax of copy() in java with parameters:

Syntax:

public static void copy(List dest, List src)

• Here, public keyword specifies that this function can be easily called in any other class.
• Static keyword refers that this function works on class level and thus need will be called by other static functions only as well as can be called using a class name not using the object of the class.
• Void keyword is used to indicate there is nothing returned by this function.

Arguments:

• dest: It is a List type variable that holds the reference for the destination list where data needs to be copied.
• src: It is a List type variable that holds the reference for the source list who needs to be copied.

Above function throws below exception:

• IndexOutOfBoundsException: This exception occurs when the size of the destination list is smaller than the size of the source list.
• UnsupportedOperationException: This exception occurs when the list iterator of the destination list does not support the set operation.

How copy() method works in Java?

• Copy() method takes 2 lists. Source list whose elements need to be copied and destination list where the elements of the list needs to be copied.
• First, it is checked if the size of the destination list is greater than the source list, otherwise IndexOutOfBoundsException exception is thrown.
• This indicates that JVM is unable to find the index for the element need to be copied because while copying the element from source list to the destination list, the index of the element is also taken care of. If in case there is one element present in the destination list at the same index, the particular element is overwritten by the copying element.
• Else elements from the source list are copied one by one with the value of their indexes and gets copied to the destination list at the same indexes. The elements present at other indexes in the destination list remain unchanged.
• This whole operation is done using a single iteration of elements thus have linear time complexity that means complexity is O(n).

Examples of copy() in Java

Given below are the examples mentioned below:

Example #1

To illustrate the occurrence of IndexOutOfBoundsException when the size of the destination list is less than the source list.

Code:

import java.util.*;
public class Demo {
public static void main(String[] args) {
List<String> mysrclist = new ArrayList<String>(6);
List<String> mydestlist = new ArrayList<String>(11);
mysrclist.add("Lets practice");
mysrclist.add("Java");
mysrclist.add("with US");
mysrclist.add("EDUCBA");
mysrclist.add("is a great");
mysrclist.add("Learnig Platform");
Collections.copy(mydestlist, mysrclist);
System.out.println("Elements of source list: "+mysrclist);
System.out.println("Elements of destination list: "+mydestlist);
}
}

Output:

Since the size of the destination list is 0 and the size of the source list is 6, there is no place in the destination list at that particular index thus this below exception is thrown as an output.

Explanation:

• In case of the above program, 2 lists are taken and sent to the copy() method as arguments but since the size of the destination list is smaller than the size of the source list thus IndexOutOfBoundsException occurs.
• Such an issue is solved in the below example, where the size of the destination list is the same as the source list.

Example #2

Code:

import java.util.*;
public class Demo {
public static void main(String[] args) {
List<String> mysrclist = new ArrayList<String>(6);
List<String> mydestlist = new ArrayList<String>(11);
mysrclist.add("Lets practice");
mysrclist.add("Java");
mysrclist.add("with US");
System.out.println("Elements of source list: "+mysrclist);
mydestlist.add("EDUCBA");
mydestlist.add("is a great");
mydestlist.add("Learnig Platform");
System.out.println("Elements of destination list before copy() executes: "+mydestlist);
Collections.copy(mydestlist, mysrclist);
System.out.println("Elements of destination list after copy() executes: "+mydestlist);       }
}

Output:

Explanation:

• In the above example, the source list has 3 elements at 0,1 and 2 index the same as the destination list.
• When these 2 lists are passed in copy function since the size of the 2 lists are the same thus elements in the destination list get overwritten by the elements of the source list at the same indexes.

Example #3

In this example, we will see how elements of the destination list get overwritten when elements of the source list get copied into it.

Code:

import java.util.*;
public class Demo {
public static void main(String[] args) {
//Create lists for source and destination
List<String> mysrclist = new ArrayList<String>(6);
List<String> mydestlist = new ArrayList<String>(11);
//Populate two source and destination lists
mysrclist.add("DIgital Learning");
mysrclist.add("for Java");
mysrclist.add("is great");
System.out.println("Elements of source list: "+mysrclist);
mydestlist.add("Book Learning");
mydestlist.add("is");
mydestlist.add("a great");
mydestlist.add("Learnig Platform");
mydestlist.add("For All");
System.out.println("Elements of destination list before copying : "+mydestlist);
// copy into destination list
Collections.copy(mydestlist, mysrclist);
System.out.println("Elements of destination list after copying : "+mydestlist);
}
}

Output:

Explanation:

• Here we saw the elements at first 3 indexes in the destination list get overwritten when elements are copied into it and elements at other indexes remain unaffected.

Conclusion

Collections package provides us with a public static method that can be used to copy the elements of one source list into the destination list at the same indexes. This method works only in the destination list is greater than the source list and this whole operation has linear time complexity.

This is a guide to copy() in Java. Here we discuss the introduction to copy() in Java along with the respective examples for better understanding. You may also have a look at the following articles to learn more –

1. Shuffle() in Java
2. addAll() in Java
3. Java max()
4. Java Scanner Class