Java ArrayList ensureCapacity()

The ArrayList ensureCapacity() method increases the capacity of the given ArrayList instance, if necessary, to ensure that it can hold at least the number of items specified by the method argument minCapacity.

We need to use ensureCapacity() method in cases when there is a huge number of add() operations in the ArrayList. In such cases, ArrayList will be frequently resized which is an expensive operation.

1. Syntax

public void ensureCapacity(int minCapacity)

If the value of minCapacity is less than 10 which is the default capacity of ArrayList, then the capacity ensured will be 10.

2. Why ArrayList Resizing is Expensive?

Java ArrayList internally uses a backing array object elementData which is used to store the list items. All ArrayList methods operate on this elementData and items stored in it.

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    private static final int DEFAULT_CAPACITY = 10;

    transient Object[] elementData;

    //more code...
}

This is the reason why ArrayList is an ordered collection and provides index-based access to items.

Note that Arrays are fixed-size collections whereas ArrayList grows in runtime as soon as the backing array elementData is full and more elements are added to the list.

Increasing the size of elementData array is called resizing. This resizing is done in two steps:

  1. Create a new backing array with more size than previous array.
  2. Copy all elements from old array to this new array.

So basically, before adding any new item to the ArrayList with add() method, ArrayList performs a check whether there is any space left in the backing array using ensureCapacity() method.

If there is any space available in the backing array then the new element is added into the array; else a new backing array is created first.

Read More: ArrayList Sourcecode

3. ArrayList ensureCapacity() Example

Java program to use ensureCapacity() method to increase the size of an ArrayList after its initialization.

In given example, we have first created an ArrayList with size 2. Lets suppose we want to add 20 more elements to it, then during the addition resizing will happen a few times.

First-time resizing will grow the list size to 10. Then subsequent add() operations will cause the array to resize a few more times.

To avoid this resizing many times, we can call ensureCapacity() method with a size of 25. This will make enough room in the array to store all the additional 20 items that we are going to add. It improves the overall performance of the whole program.

public class ArrayListExample
{
    public static void main(String[] args)
    {
        ArrayList<> list = new ArrayList<>(2);
 
        list.add("A");
        list.add("B");
 
        System.out.println(list);
 
        list.ensureCapacity(25);
 
        list.add("C");
        list.add("D");
        list.add("E");
 
        System.out.println(list);
    }
}

Program output.

[A, B]
[A, B, C, D, E]

Happy Learning !!

Read More:

A Guide to Java ArrayList
ArrayList Java Docs

Leave a Reply

2 Comments
Most Voted
Newest Oldest
Inline Feedbacks
View all comments

About Us

HowToDoInJava provides tutorials and how-to guides on Java and related technologies.

It also shares the best practices, algorithms & solutions, and frequently asked interview questions.