2. Interface Collection

2. Interface `Collection`

2.1. Notion de Collection

Dans le cadre de l'API Collection, une collection d'objets est juste un ensemble d'objets. La notion d'ordre n'est pas définie, ni entre les objets stockés (on ne peut pas dire qu'un objet est plus grand qu'un autre), ni dans le temps (on ne peut pas dire si un objet a été rangé dans cette collection avant un autre). Les opérations que l'on peut définir sur un tel ensemble sont basiques :

on peut y ajouter des objets, un par un ou par paquets ;
on peut retirer des objets précis, un par un ou par paquets ;
on peut tester si un objet appartient à cet ensemble ;
on peut balayer l'ensemble de ces objets, mais sans prévoir l'ordre dans lequel les objets contenus seront balayés ;
on peut déterminer le cardinal de cet ensemble ;
on peut en effacer le contenu.

L’interface Collection est parente de trois autres interfaces : List, Set et sa descendante SortedSet que nous verrons dans la suite.

2.2. Détail des méthodes disponibles

Examinons le détail des méthodes disponibles sur ces ensembles.

size() et isEmpty() : retourne le nombre d'éléments portés par cette collection, et un booléen qui permet de tester si cette collection est vide ou pas.
contains(T t) : retourne true si l'objet passé en paramètre est contenu dans cette collection.
add(T t) et remove(T t) : permet d'ajouter (resp. de retirer) un objet à cette collection.
iterator() : retourne un itérateur sur les éléments de cette collection.
addAll(Collection<? extends T> collection) et removeAll(Collection<? extends T> collection) : permet d'ajouter (resp. de retirer) l'ensemble des objets passés dans la collection en paramètre.
retainAll(Collection<? extends T> collection) : permet de retirer tous les éléments de la collection qui ne se trouvent pas dans la collection passée en paramètre. Cette opération réalise l'intersection des deux collections.
containsAll(Collection<? extends T> collection) : retourne true si tous les éléments de la collection passée en paramètre se trouvent dans la collection courante. Cette opération teste l'inclusion.
clear() : efface la collection courante.
toArray(T[] a) : convertit la collection courante en tableau.

2.3. Interface `Iterator`

La méthode iterator() de l'interface Collection retourne une instance d' Iterator. Cette interface est très simple, et n'expose que trois méthodes :

hasNext() : retourne true si la collection possède encore des éléments à itérer ;
next() : retourne l'élément suivant ;
remove() : permet de retirer de la collection l'élément courant. Cette opération est optionnelle, et peut ne pas être supportée par toutes les implémentations. Si une implémentation ne supporte pas cette méthode, alors elle doit jeter l'exception UnsupportedOperationException.

2.4. Implémentation, exemples d'utilisation

Il n'y a pas d'implémentation exclusive de l'interface Collection dans l'API Java. La classe utilisée le plus souvent est ArrayList, qui est également implémentation de List. Voyons l'utilisation de cette classe sur un exemple simple.

2.4.1. Créer une collection de `String`

La création d'une collection consiste en son instanciation, et l'utilisation de sa méthode add(T). Voyons ceci sur un exemple.

Exemple 1. Création d'une collection de String

// création d'une collection de String
Collection<String> collection =  new ArrayList<String>() ;

 // ajout d'éléments à cette collection
collection.add("un") ;
collection.add("deux") ;
collection.add("trois") ;

Notons que l'on n'a pas à se soucier des problèmes de dépassement de capacité. La capacité d'une collection est censée être infinie (enfin presque...). Si l'implémentation choisie est construite sur un tableau, ce qui est le cas ici, la saturation de ce tableau doit être gérée de façon transparente par la classe d'implémentation. C'est d'ailleurs le cas ici.

2.4.2. Test d'appartenance d'un objet à une collection

L'interface Collection expose une méthode contains(T) qui nous permet de tester si un objet précis appartient à une collection.

Exemple 2. Test d'appartenance d'un objet à une collection

// test d'appartenance de "deux"
 boolean b1 = collection.contains("deux") ;
System.out.println(b1) ;  // affiche true

 // test d'appartenance de "DEUX"
 boolean b2 = collection.contains("DEUX") ;
System.out.println(b2) ;  // affiche false

Dans le cas de ArrayList cette méthode appelle la méthode equals() de l'objet passé en paramètre, pour tous les objets de la collection. Elle est donc éventuellement coûteuse.

2.4.3. Parcourir les éléments d'une collection

Il existe deux façons de faire pour parcourir les éléments d'une collection. La première consiste à créer un itérateur sur la collection, et à l'utiliser.

Exemple 3. Parcourir les éléments d'une collection avec un itérateur

// parcourir les éléments de la collection avec
 // un itérateur
Iterator<String> it = collection.iterator() ;
 while (it.hasNext()) {
	
    String element = it.next() ;  // retourne un objet de type String
    System.out.println(element) ;
}

La seconde consiste à utiliser la nouvelle syntaxe for each , introduite en Java 5.

Exemple 4. Parcourir les éléments d'une collection avec un for each

// balayer les éléments de la collection avec
 // un for each
 for (String element : collection) {
	
    System.out.println(element) ;
}

Cette seconde syntaxe est beaucoup plus légère et lisible que la première. Elle est largement suffisante lorsque l'on veut juste parcourir ses éléments. Dans les cas où l'on a besoin d'interagir avec le contenu de la collection au travers de l'itérateur, elle n'est pas utilisable.

2.4.4. Conversion d'une collection en tableau

Enfin, on peut créer un tableau à partir des éléments contenus dans une collection.

Exemple 5. Conversion d'une collection en tableau

// pattern de conversion d'une collection en tableau
String [] tab = collection.toArray(new String[] {}) ;

 // affichage du contenu du tableau
 for (String element : tab) {
	
    System.out.println(element) ;
}