Method that returns an ArrayList java

Learn to get an element from an ArrayList using its index position. We will be using ArrayList.get() method to get the object at the specified index of the arraylist.

ArrayList<String> list = //List instance String firstElement = list.get(0); String sixthElement = list.get(5);

1. ArrayList get() Method

ArrayList.get(int index) method returns the element at the specified position 'index' in the list.

1.1. Syntax

public Object get( int index );

1.2. Method Parameter

index – index of the element to return. A valid index is always be between 0 (inclusive) to the size of ArrayList (exclusive).

For example, if ArrayList holds 10 objects then a valid argument index will be between 0 to 9 (both inclusive).

1.3. Return Value

The get() method returns the reference of the object present at the specified index.

1.4. IndexOutOfBoundsException

An invalid index argument will cause IndexOutOfBoundsException error.

Exception in thread "main" java.lang.IndexOutOfBoundsException: Index: 4, Size: 4 at java.util.ArrayList.rangeCheck(ArrayList.java:653) at java.util.ArrayList.get(ArrayList.java:429) at com.howtodoinjava.example.ArrayListExample.main(ArrayListExample.java:12)

2. ArrayList get() Example

Java program for how to get an object from ArrayList by its index location. In this example, we want to get the object stored at index locations 0 and 1.

import java.util.ArrayList; import java.util.Arrays; public class ArrayListExample { public static void main(String[] args) { ArrayList<String> list = new ArrayList<>(Arrays .asList("alex", "brian", "charles", "dough")); String firstName = list.get(0); //alex String secondName = list.get(1); //brian System.out.println(firstName); System.out.println(secondName); } }

Program output.

alex brian

Happy Learning !!

Let us know if you liked the post. That’s the only way we can improve.

ArrayList is a part of collection framework and is present in java.util package. It provides us with dynamic arrays in Java. Though, it may be slower than standard arrays but can be helpful in programs where lots of manipulation in the array is needed. This class is found in java.util package. 

Illustration: 

Example: The following implementation demonstrates how to create and use an ArrayList.



    public static void main(String[] args)

            = new ArrayList<Integer>(n);

        for (int i = 1; i <= n; i++)

        System.out.println(arrli);

        System.out.println(arrli);

        for (int i = 0; i < arrli.size(); i++)

            System.out.print(arrli.get(i) + " ");

Output [1, 2, 3, 4, 5] [1, 2, 3, 5] 1 2 3 5

Since ArrayList is a dynamic array and we do not have to specify the size while creating it, the size of the array automatically increases when we dynamically add and remove items. Though the actual library implementation may be more complex, the following is a very basic idea explaining the working of the array when the array becomes full and if we try to add an item:

  • Creates a bigger-sized memory on heap memory (for example memory of double size).
  • Copies the current memory elements to the new memory.
  • New item is added now as there is bigger memory available now.
  • Delete the old memory.

Important Features:

  • ArrayList inherits AbstractList class and implements the List interface.
  • ArrayList is initialized by the size. However, the size is increased automatically if the collection grows or shrinks if the objects are removed from the collection.
  • Java ArrayList allows us to randomly access the list.
  • ArrayList can not be used for primitive types, like int, char, etc. We need a wrapper class for such cases.
  • ArrayList in Java can be seen as a vector in C++.
  • ArrayList is not Synchronized. Its equivalent synchronized class in Java is Vector.

Let’s understand the Java ArrayList in depth. Look at the below image:

In the above illustration, AbstractList, CopyOnWriteArrayList, and the AbstractSequentialList are the classes that implement the list interface. A separate functionality is implemented in each of the mentioned classes. They are:

  1. AbstractList: This class is used to implement an unmodifiable list, for which one needs to only extend this AbstractList Class and implement only the get() and the size() methods.
  2. CopyOnWriteArrayList: This class implements the list interface. It is an enhanced version of ArrayList in which all the modifications(add, set, remove, etc.) are implemented by making a fresh copy of the list.
  3. AbstractSequentialList: This class implements the Collection interface and the AbstractCollection class. This class is used to implement an unmodifiable list, for which one needs to only extend this AbstractList Class and implement only the get() and the size() methods.

Constructors in the ArrayList

In order to create an ArrayList, we need to create an object of the ArrayList class. The ArrayList class consists of various constructors which allow the possible creation of the array list. The following are the constructors available in this class:
 

1. ArrayList(): This constructor is used to build an empty array list. If we wish to create an empty ArrayList with the name arr, then, it can be created as:

ArrayList arr = new ArrayList(); 
 

2. ArrayList(Collection c): This constructor is used to build an array list initialized with the elements from the collection c. Suppose, we wish to create an ArrayList arr which contains the elements present in the collection c, then, it can be created as: 
 

ArrayList arr = new ArrayList(c); 
 

3. ArrayList(int capacity): This constructor is used to build an array list with initial capacity being specified. Suppose we wish to create an ArrayList with the initial size being N, then, it can be created as:

ArrayList arr = new ArrayList(N);  

Methods in Java ArrayList

Method Description
add(int index, Object element) This method is used to insert a specific element at a specific position index in a list.
add(Object o) This method is used to append a specific element to the end of a list.
addAll(Collection C) This method is used to append all the elements from a specific collection to the end of the mentioned list, in such an order that the values are returned by the specified collection’s iterator.
addAll(int index, Collection C) Used to insert all of the elements starting at the specified position from a specific collection into the mentioned list.
clear() This method is used to remove all the elements from any list.
clone() This method is used to return a shallow copy of an ArrayList.
contains?(Object o) Returns true if this list contains the specified element.
ensureCapacity?(int minCapacity) Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
forEach?(Consumer<? super E> action) Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
get?(int index) Returns the element at the specified position in this list.
indexOf(Object O) The index the first occurrence of a specific element is either returned, or -1 in case the element is not in the list.
isEmpty?() Returns true if this list contains no elements.
lastIndexOf(Object O) The index of the last occurrence of a specific element is either returned or -1 in case the element is not in the list.
listIterator?() Returns a list iterator over the elements in this list (in proper sequence).
listIterator?(int index) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
remove?(int index) Removes the element at the specified position in this list.
remove?(Object o) Removes the first occurrence of the specified element from this list, if it is present.
removeAll?(Collection c) Removes from this list all of its elements that are contained in the specified collection.
removeIf?(Predicate filter) Removes all of the elements of this collection that satisfy the given predicate.
removeRange?(int fromIndex, int toIndex) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
retainAll?(Collection<?> c) Retains only the elements in this list that are contained in the specified collection.
set?(int index, E element) Replaces the element at the specified position in this list with the specified element.
size?() Returns the number of elements in this list.
spliterator?() Creates a late-binding and fail-fast Spliterator over the elements in this list.
subList?(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
toArray() This method is used to return an array containing all of the elements in the list in the correct order.
toArray(Object[] O) It is also used to return an array containing all of the elements in this list in the correct order same as the previous method.
trimToSize() This method is used to trim the capacity of the instance of the ArrayList to the list’s current size.

Note: You can also create a generic ArrayList:

// Creating generic integer ArrayList ArrayList<Integer> arrli = new ArrayList<Integer>();

Let’s see how to perform some basics operations on the ArrayList as listed which we are going to discuss further alongside implementing every operation.

  • Adding element to List
  • Changing elements
  • Removing elements
  • Iterating elements   

Operation 1: Adding Elements

In order to add an element to an ArrayList, we can use the add() method. This method is overloaded to perform multiple operations based on different parameters. They are as follows:  

  • add(Object): This method is used to add an element at the end of the ArrayList.
  • add(int index, Object): This method is used to add an element at a specific index in the ArrayList.

Example:

    public static void main(String args[])

        ArrayList<String> al = new ArrayList<>();

Output:  [Geeks, For, Geeks]

Operation 2: Changing Elements

After adding the elements, if we wish to change the element, it can be done using the set() method. Since an ArrayList is indexed, the element which we wish to change is referenced by the index of the element. Therefore, this method takes an index and the updated element which needs to be inserted at that index. 

Example

    public static void main(String args[])

        ArrayList<String> al = new ArrayList<>();

        System.out.println("Initial ArrayList " + al);

        System.out.println("Updated ArrayList " + al);

Output:  Initial ArrayList [Geeks, Geeks, Geeks] Updated ArrayList [Geeks, For, Geeks]

Operation 3: Removing Elements

In order to remove an element from an ArrayList, we can use the remove() method. This method is overloaded to perform multiple operations based on different parameters. They are as follows: 

  • remove(Object): This method is used to simply remove an object from the ArrayList. If there are multiple such objects, then the first occurrence of the object is removed.
  • remove(int index): Since an ArrayList is indexed, this method takes an integer value which simply removes the element present at that specific index in the ArrayList. After removing the element, all the elements are moved to the left to fill the space and the indices of the objects are updated.

Example

    public static void main(String args[])

        ArrayList<String> al = new ArrayList<>();

        System.out.println("Initial ArrayList " + al);

        System.out.println("After the Index Removal " + al);

        System.out.println("After the Object Removal "

Output:  Initial ArrayList [Geeks, For, Geeks] After the Index Removal [Geeks, Geeks] After the Object Removal [Geeks]

Operation 4: Iterating the ArrayList

There are multiple ways to iterate through the ArrayList. The most famous ways are by using the basic for loop in combination with a get() method to get the element at a specific index and the advanced for loop. 

Example

    public static void main(String args[])

        ArrayList<String> al = new ArrayList<>();

        for (int i = 0; i < al.size(); i++) {

            System.out.print(al.get(i) + " ");

            System.out.print(str + " ");

Output:  Geeks For Geeks Geeks For Geeks

Must Read: Array vs ArrayList in Java


Practice Tags :