Tutoriel sur les méthodes de liste Java - Exemple d'API Util List

Les listes sont des structures de données couramment utilisées dans tous les langages de programmation.

Dans ce didacticiel, nous allons étudier l'API List de Java. Nous commencerons par des opérations de base, puis nous entrerons dans des choses plus avancées (comme une comparaison de différents types de listes, tels que ArrayList et LinkedList).

Je vais également vous donner quelques lignes directrices pour vous aider à choisir la mise en œuvre de liste la mieux adaptée à votre situation.

Bien que les connaissances de base de Java soient suffisantes pour suivre le didacticiel, la dernière section nécessite des structures de données de base (Array, LinkedList) et des connaissances Big-O. Si vous ne les connaissez pas, n'hésitez pas à sauter cette section.

Définition des listes

Les listes sont des collections ordonnées d'objets. Ils sont similaires aux séquences en mathématiques dans ce sens. Cependant, ils ne ressemblent pas aux ensembles qui n'ont pas un certain ordre.

Quelques points à garder à l'esprit: les listes peuvent contenir des doublons et des éléments nuls. Ce sont des types de référence ou d'objet, et comme tous les objets en Java, ils sont stockés dans le tas.

Une liste en Java est une interface et il existe de nombreux types de liste qui implémentent cette interface.

J'utiliserai ArrayList dans les premiers exemples, car c'est le type de liste le plus couramment utilisé.

ArrayList est essentiellement un tableau redimensionnable. Presque toujours, vous souhaitez utiliser ArrayList sur des tableaux normaux car ils fournissent de nombreuses méthodes utiles.

Le seul avantage d'un tableau était sa taille fixe (en n'allouant pas plus d'espace que nécessaire). Mais les listes prennent également en charge les tailles fixes maintenant.

Comment créer une liste en Java

Assez bavardé, commençons par créer notre liste.

import java.util.ArrayList; import java.util.List; public class CreateArrayList { public static void main(String[] args) { ArrayList list0 = new ArrayList(); // Makes use of polymorphism List list = new ArrayList(); // Local variable with "var" keyword, Java 10 var list2 = new ArrayList(); } }

Dans les crochets (), nous spécifions le type d'objets que nous allons stocker.

Gardez à l'esprit que le type entre crochets doit être un type d'objet et non un type primitif . Par conséquent, nous devons utiliser des wrappers d'objet, une classe Integer au lieu de int, Double au lieu de double, etc.

Il existe de nombreuses façons de créer une ArrayList, mais j'ai présenté trois méthodes courantes dans l'extrait de code ci-dessus.

La première consiste à créer l'objet à partir de la classe ArrayList concrète en spécifiant ArrayList sur le côté gauche de l'affectation.

Le deuxième extrait de code utilise le polymorphisme en utilisant la liste sur le côté gauche. Cela rend l'affectation faiblement couplée à la classe ArrayList et nous permet d'assigner d'autres types de listes et de passer facilement à une implémentation différente de List.

La troisième méthode est la manière Java 10 de créer des variables locales en utilisant le mot-clé var. Le compilateur interprète le type de variable en vérifiant le côté droit.

Nous pouvons voir que toutes les affectations aboutissent au même type:

System.out.println(list0.getClass()); System.out.println(list.getClass()); System.out.println(list2.getClass());

Production:

class java.util.ArrayList class java.util.ArrayList class java.util.ArrayList 

Nous pouvons également spécifier la capacité initiale de la liste.

List list = new ArrayList(20);

Ceci est utile car chaque fois que la liste est pleine et que vous essayez d'ajouter un autre élément, la liste actuelle est copiée dans une nouvelle liste avec le double de la capacité de la liste précédente. Tout cela se passe dans les coulisses.

Cette opération rend notre complexité O (n) , cependant, nous voulons donc l'éviter. La capacité par défaut est de 10, donc si vous savez que vous allez stocker plus d'éléments, vous devez spécifier la capacité initiale.

Comment ajouter et mettre à jour des éléments de liste en Java

Pour ajouter des éléments à la liste, nous pouvons utiliser la méthode add . Nous pouvons également spécifier l'index du nouvel élément, mais soyez prudent lorsque vous faites cela car cela peut entraîner une IndexOutOfBoundsException .

import java.util.ArrayList; public class AddElement { public static void main(String[] args) { ArrayList list = new ArrayList(); list.add("hello"); list.add(1, "world"); System.out.println(list); } }

Production:

[hello, world]

Nous pouvons utiliser la méthode set pour mettre à jour un élément.

list.set(1, "from the otherside"); System.out.println(list);

Production:

[hello, world] [hello, from the otherside]

Comment récupérer et supprimer des éléments de liste en Java

Pour récupérer un élément de la liste, vous pouvez utiliser la méthode get et fournir l'index de l'élément que vous souhaitez obtenir.

import java.util.ArrayList; import java.util.List; public class GetElement { public static void main(String[] args) { List list = new ArrayList(); list.add("hello"); list.add("freeCodeCamp"); System.out.println(list.get(1)); } }

Production:

freeCodeCamp 

La complexité de cette opération sur ArrayList est O (1) car elle utilise un tableau à accès aléatoire régulier en arrière-plan.

Pour supprimer un élément de ArrayList, la méthode remove est utilisée.

list.remove(0);

Cela supprime l'élément à l'index 0, qui est "bonjour" dans cet exemple.

We can also call the remove method with an element to find and remove it. Keep in mind that it only removes the first occurrence of the element if it is present.

public static void main(String[] args) { List list = new ArrayList(); list.add("hello"); list.add("freeCodeCamp"); list.add("freeCodeCamp"); list.remove("freeCodeCamp"); System.out.println(list); }

Output:

[hello, freeCodeCamp]

To remove all occurrences, we can use the removeAll method in the same way.

These methods are inside the List interface, so every List implementations has them (whether it is ArrayList, LinkedList or Vector).

How to Get the Length of a List in Java

To get the length of a list, or the number of elements,we can use the size() method.

import java.util.ArrayList; import java.util.List; public class GetSize { public static void main(String[] args) { List list = new ArrayList(); list.add("Welcome"); list.add("to my post"); System.out.println(list.size()); } } 

Output:

2

Two-Dimensional Lists in Java

It is possible to create two-dimensional lists, similar to 2D arrays.

ArrayList listOfLists = new ArrayList();

We use this syntax to create a list of lists, and each inner list stores integers. But we have not initialized the inner lists yet. We need to create and put them on this list ourselves:

int numberOfLists = 3; for (int i = 0; i < numberOfLists; i++) { listOfLists.add(new ArrayList()); }

I am initializing my inner lists, and I am adding 3 lists in this case. I can also add lists later if I need to.

Now we can add elements to our inner lists. To add an element, we need to get the reference to the inner list first.

For example, let's say we want to add an element to the first list. We need to get the first list, then add to it.

listOfLists.get(0).add(1);

Here is an example for you. Try to guess the output of the below code segment:

public static void main(String[] args) { ArrayList listOfLists = new ArrayList(); System.out.println(listOfLists); int numberOfLists = 3; for (int i = 0; i < numberOfLists; i++) { listOfLists.add(new ArrayList()); } System.out.println(listOfLists); listOfLists.get(0).add(1); listOfLists.get(1).add(2); listOfLists.get(2).add(0,3); System.out.println(listOfLists); }

Output:

[] [[], [], []] [[1], [2], [3]]

Notice that it is possible to print the lists directly (unlike with regular arrays) because they override the toString() method.

Useful Methods in Java

There are some other useful methods and shortcuts that are used frequently. In this section I want to familiarize you with some of them so you will have an easier time working with lists.

How to Create a List with Elements in Java

It is possible to create and populate the list with some elements in a single line. There are two ways to do this.

The following is the old school way:

public static void main(String[] args) { List list = Arrays.asList( "freeCodeCamp", "let's", "create"); }

You need to be cautious about one thing when using this method: Arrays.asList returns an immutable list. So if you try to add or remove elements after creating the object, you will get an UnsupportedOperationException.

You might be tempted to use final keyword to make the list immutable but it won't work as expected.

It just makes sure that the reference to the object does not change – it does not care about what is happening inside the object. So it permits inserting and removing.

final List list2 = new ArrayList(); list2.add("erinc.io is the best blog ever!"); System.out.println(list2);

Output:

[erinc.io is the best blog ever!] 

Now let's look at the modern way of doing it:

ArrayList friends = new ArrayList(List.of("Gulbike", "Sinem", "Mete")); 

The List.of method was shipped with Java 9. This method also returns an immutable list but we can pass it to the  ArrayList constructor to create a mutable list with those elements. We can add and remove elements to this list without any problems.

How to Create a List with N Copies of Some Element in Java

Java provides a method called NCopies that is especially useful for benchmarking. You can fill an array with any number of elements in a single line.

public class NCopies { public static void main(String[] args) { List list = Collections.nCopies(10, "HELLO"); System.out.println(list); } }

Output:

[HELLO, HELLO, HELLO, HELLO, HELLO, HELLO, HELLO, HELLO, HELLO, HELLO] 

How to Clone a List in Java

As previously mentioned, Lists are reference types, so the rules of passing by reference apply to them.

public static void main(String[] args) { List list1 = new ArrayList(); list1.add("Hello"); List list2 = list1; list2.add(" World"); System.out.println(list1); System.out.println(list2); }

Output:

[Hello, World] [Hello, World]

The list1 variable holds a reference to the list. When we assign it to list2 it also points to the same object. If we do not want the original list to change, we can clone the list.

ArrayList list3 = (ArrayList) list1.clone(); list3.add(" Of Java"); System.out.println(list1); System.out.println(list3);

Output:

[Hello, World] [Hello, World, Of Java]

Since we cloned list1, list3 holds a reference to its clone in this case. Therefore list1 remains unchanged.

How to Copy a List to an Array in Java

Sometimes you need to convert your list to an array to pass it into a method that accepts an array. You can use the following code to achieve that:

List list = new ArrayList(List.of(1, 2)); Integer[] toArray = list.toArray(new Integer[0]);

You need to pass an array and the toArray method returns that array after filling it with the elements of the list.

How to Sort a List in Java

To sort a list we can use Collections.sort. It sorts in ascending order by default but you can also pass a comparator to sort with custom logic.

List toBeSorted = new ArrayList(List.of(3,2,4,1,-2)); Collections.sort(toBeSorted); System.out.println(toBeSorted);

Output:

[-2, 1, 2, 3, 4]

How do I choose which list type to use?

Before finishing this article, I want to give you a brief performance comparison of different list implementations so you can choose which one is better for your use case.

We will compare ArrayList, LinkedList and Vector. All of them have their ups and downs so make sure you consider the specific context before you decide.

Java ArrayList vs LinkedList

Here is a comparison of runtimes in terms of algorithmic complexity.

| | ArrayList | LinkedList | |-----------------------|----------------------------|------------| | GET(index) | O(1) | O(n) | | GET from Start or End | O(1) | O(1) | | ADD | O(1), if list is full O(n) | O(1) | | ADD(index) | O(n) | O(1) | | Remove(index) | O(n) | O(1) | | Search and Remove | O(n) | O(n) |

Generally, the get operation is much faster on ArrayList but add and remove are faster on LinkedList.

ArrayList uses an array behind the scenes, and whenever an element is removed, array elements need to be shifted (which is an O(n) operation).

Choosing data structures is a complex task and there is no recipe that applies to every situation. Still, I will try to provide some guidelines to help you make that decision easier:

  • If you plan to do more get and add operations other than remove, use ArrayList since the get operation is too costly on LinkedList. Keep in mind that insertion is O(1) only if you call it without specifying the index and add to the end of the list.
  • If you are going to remove elements and/or insert in the middle (not at the end) frequently, you can consider switching to a LinkedList because these operations are costly on ArrayList.
  • Keep in mind that if you access the elements sequentially (with an iterator), you will not experience a performance loss with LinkedList while getting elements.

Java ArrayList vs Vector

Vector is very similar to ArrayList. If you are coming from a C++ background, you might be tempted to use a Vector, but its use case is a bit different than C++.

Vector's methods have the synchronized keyword, so Vector guarantees thread safety whereas ArrayList does not.

You might prefer Vector over ArrayList in multithreaded programming or you can use ArrayList and handle the synchronization yourself.

In a single-threaded program, it is better to stick with ArrayList because thread-safety comes with a performance cost.

Conclusion

In this post, I have tried to provide an overview of Java's List API. We have learned to use basic methods, and we've also looked at some more advanced tricks to make our lives easier.

We also made a comparison of ArrayList, LinkedList and Vector which is a commonly asked topic in interviews.

Thank you for taking the time to read the whole article and I hope it was helpful.

You can access the whole code from this repository.

If you are interested in reading more articles like this, you can subscribe to my blog's mailing list to get notified when I publish a new article.