Sun Educational Services

Module 9
Collections and Generics Framework

Java Programming Language

Sun Educational Services

Objectives
Describe the Collections
Describe the general purpose implementations of the
core interfaces in the Collections framework
Examine the Map interface
Examine the legacy collection classes
Create natural and custom ordering by implementing
the Comparable and Comparator interfaces
Use generic collections
Use type parameters in generic classes
Refactor existing non-generic code
Write a program to iterate over a collection
Examine the enhanced for loop
Java Programming Language
Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 2 of 40

Sun Educational Services

The Collections API

A collection is a single object managing a group of
objects known as its elements.
The Collections API contains interfaces that group
objects as one of the following:
Collection - A group of objects called elements;
implementations determine whether there is specific
ordering and whether duplicates are permitted.
Set - An unordered collection; no duplicates are
permitted.
List - An ordered collection; duplicates are
permitted.

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 3 of 40

Sun Educational Services

The Collections API

<<interface>>

Collection
+add
+remove
+size
+isEmpty
+contains
+iterator

<<interface>>

<<interface>>

List

Set

HashSet

<<interface >>

SortedSet

+add
+remove
+get
+set
+indexOf
+listIterator

TreeSet
ArrayList

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

LinkedList

Module 9, slide 4 of 40

Sun Educational Services

Collection Implementations
There are several general purpose implementations of the
core interfaces (Set, List, Deque and Map)
Hash
Table
Set

Resizable
Array

HashSet

Balanced
Tree

Linked List

TreeSet

LinkedHashSet

List

ArrayList

LinkedList

Deque

ArrayDeque

LinkedList

Map

HashMap

Hash Table +
Linked List

TreeMap

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

LinkedHashMap

Module 9, slide 5 of 40

Sun Educational Services

A Set Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14

import java.util.*;
public class SetExample {
public static void main(String[] args) {
Set set = new HashSet();
set.add("one");
set.add("second");
set.add("3rd");
set.add(new Integer(4));
set.add(new Float(5.0F));
set.add("second");
// duplicate, not added
set.add(new Integer(4)); // duplicate, not added
System.out.println(set);
}
}

The output generated from this program is:

[one, second, 5.0, 3rd, 4]

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 6 of 40

Sun Educational Services

A List Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14

import java.util.*
public class ListExample {
public static void main(String[] args) {
List list = new ArrayList();
list.add("one");
list.add("second");
list.add("3rd");
list.add(new Integer(4));
list.add(new Float(5.0F));
list.add("second");
// duplicate, is added
list.add(new Integer(4)); // duplicate, is added
System.out.println(list);
}
}

The output generated from this program is:

[one, second, 3rd, 4, 5.0, second, 4]

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 7 of 40

Sun Educational Services

The Map Interface

Maps are sometimes called associative arrays
A Map object describes mappings from keys to values:
Duplicate keys are not allowed
One-to-many mappings from keys to values is not
permitted
The contents of the Map interface can be viewed and
manipulated as collections
entrySet - Returns a Set of all the key-value pairs.
keySet - Returns a Set of all the keys in the map.
values - Returns a Collection of all values in the
map.
Java Programming Language
Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 8 of 40

Sun Educational Services

The Map Interface API

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 9 of 40

Sun Educational Services

A Map Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

import java.util.*;
public class MapExample {
public static void main(String args[]) {
Map map = new HashMap();
map.put("one","1st");
map.put("second", new Integer(2));
map.put("third","3rd");
// Overwrites the previous assignment
map.put("third","III");
// Returns set view of keys
Set set1 = map.keySet();
// Returns Collection view of values
Collection collection = map.values();
// Returns set view of key value mappings
Set set2 = map.entrySet();
System.out.println(set1 + "\n" + collection + "\n" + set2);
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 10 of 40

Sun Educational Services

A Map Example
Output generated from the MapExample program:
[second, one, third]
[2, 1st, III]
[second=2, one=1st, third=III]

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 11 of 40

Sun Educational Services

Legacy Collection Classes

Collections in the JDK include:
The Vector class, which implements the List
interface.
The Stack class, which is a subclass of the Vector class
and supports the push, pop, and peek methods.
The Hashtable class, which implements the Map
interface.
The Properties class is an extension of Hashtable
that only uses Strings for keys and values.
Each of these collections has an elements method that
returns an Enumeration object. The Enumeration
interface is incompatible with, the Iterator interface.
Java Programming Language
Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 12 of 40

Sun Educational Services

Ordering Collections
The Comparable and Comparator interfaces are useful for
ordering collections:
The Comparable interface imparts natural ordering to
classes that implement it.
The Comparator interface specifies order relation. It
can also be used to override natural ordering.
Both interfaces are useful for sorting collections.

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 13 of 40

Sun Educational Services

The Comparable Interface

Imparts natural ordering to classes that implement it:
Used for sorting
The compareTo method should be implemented to
make any class comparable:
int compareTo(Object o) method
The String, Date, and Integer classes implement the
Comparable interface
You can sort the List elements containing objects that
implement the Comparable interface

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 14 of 40

Sun Educational Services

The Comparable Interface

While sorting, the List elements follow the natural
ordering of the element types
String elements - Alphabetical order
Date elements - Chronological order
Integer elements - Numerical order

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 15 of 40

Sun Educational Services

Example of the Comparable Interface

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

import java.util.*;
class Student implements Comparable {
String firstName, lastName;
int studentID=0;
double GPA=0.0;
public Student(String firstName, String lastName, int studentID,
double GPA) {
if (firstName == null || lastName == null || studentID == 0
|| GPA == 0.0) {throw new IllegalArgumentException();}
this.firstName = firstName;
this.lastName = lastName;
this.studentID = studentID;
this.GPA = GPA;
}
public String firstName() { return firstName; }
public String lastName() { return lastName; }
public int studentID() { return studentID; }
public double GPA() { return GPA; }

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 16 of 40

Sun Educational Services

Example of the Comparable Interface

19
20
21
22
23
24
25
26
27
28
29

// Implement compareTo method.

public int compareTo(Object o) {
double f = GPA-((Student)o).GPA;
if (f == 0.0)
return 0;
// 0 signifies equals
else if (f<0.0)
return -1;
// negative value signifies less than or before
else
return 1;
// positive value signifies more than or after
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 17 of 40

Sun Educational Services

Example of the Comparable Interface

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

import java.util.*;
public class ComparableTest {
public static void main(String[] args) {
TreeSet studentSet = new TreeSet();
studentSet.add(new Student("Mike", "Hauffmann",101,4.0));
studentSet.add(new Student("John", "Lynn",102,2.8 ));
studentSet.add(new Student("Jim", "Max",103, 3.6));
studentSet.add(new Student("Kelly", "Grant",104,2.3));
Object[] studentArray = studentSet.toArray();
Student s;
for(Object obj : studentArray){
s = (Student) obj;
System.out.printf("Name = %s %s ID = %d GPA = %.1f\n",
s.firstName(), s.lastName(), s.studentID(), s.GPA());
}
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 18 of 40

Sun Educational Services

Example of the Comparable Interface

Generated Output:
Name
Name
Name
Name

=
=
=
=

Kelly Grant ID = 104 GPA = 2.3

John Lynn ID = 102 GPA = 2.8
Jim Max ID = 103 GPA = 3.6
Mike Hauffmann ID = 101 GPA = 4.0

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 19 of 40

Sun Educational Services

The Comparator Interface

Represents an order relation
Used for sorting
Enables sorting in an order different from the natural
order
Used for objects that do not implement the Comparable
interface
Can be passed to a sort method
You need the compare method to implement the Comparator
interface:
int compare(Object o1, Object o2) method

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 20 of 40

Sun Educational Services

Example of the Comparator Interface

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

class Student {
String firstName, lastName;
int studentID=0;
double GPA=0.0;
public Student(String firstName, String lastName,
int studentID, double GPA) {
if (firstName == null || lastName == null || studentID == 0 ||
GPA == 0.0) throw new NullPointerException();
this.firstName = firstName;
this.lastName = lastName;
this.studentID = studentID;
this.GPA = GPA;
}
public String firstName() { return firstName; }
public String lastName() { return lastName; }
public int studentID() { return studentID; }
public double GPA() { return GPA; }
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 21 of 40

Sun Educational Services

Example of the Comparator Interface

1
2
3
4
5
6
7

import java.util.*;
public class NameComp implements Comparator {
public int compare(Object o1, Object o2) {
return
(((Student)o1).firstName.compareTo(((Student)o2).firstName));
}
}

1
import java.util.*;
2 public class GradeComp implements Comparator {
3
public int compare(Object o1, Object o2) {
4
if (((Student)o1).GPA == ((Student)o2).GPA)
5
return 0;
6
else if (((Student)o1).GPA < ((Student)o2).GPA)
7
return -1;
8
else
9
return 1;
10
}
11 }

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 22 of 40

Sun Educational Services

Example of the Comparator Interface

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

import java.util.*;
public class ComparatorTest {
public static void main(String[] args) {
Comparator c = new NameComp();
TreeSet studentSet = new TreeSet(c);
studentSet.add(new Student("Mike", "Hauffmann",101,4.0));
studentSet.add(new Student("John", "Lynn",102,2.8 ));
studentSet.add(new Student("Jim", "Max",103, 3.6));
studentSet.add(new Student("Kelly", "Grant",104,2.3));
Object[] studentArray = studentSet.toArray();
Student s;
for(Object obj : studentArray) {
s = (Student) obj;
System.out.println("Name = %s %s ID = %d GPA = %.1f\n",
s.firstName(), s.lastName(), s.studentID(), s.GPA());
}
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 23 of 40

Sun Educational Services

Example of the Comparator Interface

Name
Name
Name
Name

=
=
=
=

Jim Max ID = 0
John Lynn ID =
Kelly Grant ID
Mike Hauffmann

GPA = 3.6
0 GPA = 2.8
= 0 GPA = 2.3
ID = 0 GPA = 4.0

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 24 of 40

Sun Educational Services

Generics
Generics are described as follows:
Provide compile-time type safety
Eliminate the need for casts
Provide the ability to create compiler-checked
homogeneous collections

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 25 of 40

Sun Educational Services

Generics
Using non-generic collections:
ArrayList list = new ArrayList();
list.add(0, new Integer(42));
int total = ((Integer)list.get(0)).intValue();

Using generic collections:

ArrayList<Integer> list = new ArrayList<Integer>();
list.add(0, new Integer(42));
int total = list.get(0).intValue();

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 26 of 40

Sun Educational Services

Generic Set Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14

import java.util.*;
public class GenSetExample {
public static void main(String[] args) {
Set<String> set = new HashSet<String>();
set.add("one");
set.add("second");
set.add("3rd");
// This line generates compile error
set.add(new Integer(4));
set.add("second");
// Duplicate, not added
System.out.println(set);
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 27 of 40

Sun Educational Services

Generic Map Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

import java.util.*;
public class MapPlayerRepository {
HashMap<String, String> players;
public MapPlayerRepository() {
players = new HashMap<String, String> ();
}
public String get(String position) {
String player = players.get(position);
return player;
}
public void put(String position, String name) {
players.put(position, name);
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 28 of 40

Sun Educational Services

Generics: Examining Type Parameters

Shows how to use type parameters
Category

Non Generic Class

Generic Class

Class
declaration

public class ArrayList extends

AbstractList implements List

public class ArrayList<E> extends

AbstractList<E> implements List <E>

Constructor
declaration

public ArrayList
(int capacity);

public ArrayList<E>
(int capacity);

Method
declaration

public void add((Object o)

public void add(E o)

public Object get(int index)

public E get(int index)

Variable
declaration
examples

ArrayList list1;

ArrayList <String> list1;

ArrayList list2;

ArrayList <Date> list2;

Instance
declaration
examples

list1 = new ArrayList(10);

list1= new ArrayList<String> (10);

list2 = new ArrayList(10);

list2= new ArrayList<Date> (10);

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 29 of 40

Sun Educational Services

Generic Collections API

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 30 of 40

Sun Educational Services

Wild Card Type Parameters

Account

SavingsAccount

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

CheckingAccount

Module 9, slide 31 of 40

Sun Educational Services

The Type-Safety Guarantee

1
2
3
4
5
6
7
8
9
10
11
12

public class TestTypeSafety {

public static void main(String[] args) {
List<CheckingAccount> lc = new ArrayList<CheckingAccount>();
lc.add(new CheckingAccount("Fred")); // OK
lc.add(new SavingsAccount("Fred")); // Compile error!
// therefore...
CheckingAccount ca = lc.get(0);

// Safe, no cast required

}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 32 of 40

Sun Educational Services

The Invariance Challenge

7
8
9
10
11
12
13
14
15
16
17
18
19
20

List<Account> la;
List<CheckingAccount> lc = new ArrayList<CheckingAccount>();
List<SavingsAccount> ls = new ArrayList<SavingsAccount>();
//if the following were possible...
la = lc;
la.add(new CheckingAccount("Fred"));
//then the following must also be possible...
la = ls;
la.add(new CheckingAccount("Fred"));
//so...
SavingsAccount sa = ls.get(0); //aarrgghh!!

In fact, la=lc; is illegal, so even though a CheckingAccount

is an Account, an ArrayList<CheckingAccount> is not an
ArrayList<Account>.
Java Programming Language
Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 33 of 40

Sun Educational Services

The Covariance Response

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

public static void printNames(List <? extends Account> lea) {

for (int i=0; i < lea.size(); i++) {
System.out.println(lea.get(i).getName());
}
}
public static void main(String[] args) {
List<CheckingAccount> lc = new ArrayList<CheckingAccount>();
List<SavingsAccount> ls = new ArrayList<SavingsAccount>();
printNames(lc);
printNames(ls);
//but...
List<? extends Object> leo = lc; //OK
leo.add(new CheckingAccount("Fred"));//Compile error!
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 34 of 40

Sun Educational Services

Generics: Refactoring Existing NonGeneric Code

1
2
3
4
5
6
7
8

import java.util.*;
public class GenericsWarning {
public static void main(String[] args) {
List list = new ArrayList();
list.add(0, new Integer(42));
int total = ((Integer)list.get(0).intValue();
}
}

javac GenericsWarning.java
Note: GenericsWarning.java uses unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.
javac -Xlint:unchecked GenericsWarning.java
GenericsWarning.java:7: warning: [unchecked] unchecked call to add(int,E)
as a member of the raw type java.util.ArrayList
list.add(0, new Integer(42));
^
1 warning
Java Programming Language
Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 35 of 40

Sun Educational Services

Iterators

1
2
3
4
5
6

Iteration is the process of retrieving every element in a

collection.
The basic Iterator interface allows you to scan
forward through any collection.
A List object supports the ListIterator, which
allows you to scan the list backwards and insert or
modify elements.

List<Student> list = new ArrayList<Student>();

// add some elements
Iterator<Student> elements = list.iterator();
while (elements.hasNext()) {
System.out.println(elements.next());
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 36 of 40

Sun Educational Services

Generic Iterator Interfaces

interface

Iterator<E>
+hasNext() : boolean
+next() : E
+remove()

interface

ListIterator<E>
+hasPrevious() : boolean
+previous() : E
+add(element : E)
+set(element : E)
Java Programming Language
Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 37 of 40

Sun Educational Services

The Enhanced for Loop

The enhanced for loop has the following characteristics:
Simplified iteration over collections
Much shorter, clearer, and safer
Effective for arrays
Simpler when using nested loops
Iterator disadvantages
removed
Iterator
occur three times per loop.
Iterators
arevariables
error prone:
This provides the opportunity for code to go wrong.

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 38 of 40

Sun Educational Services

The Enhanced for Loop

An enhanced for loop can look like the following:
Using the iterator with a traditional for loop:
public void deleteAll(Collection<NameList> c){
for ( Iterator<NameList> i = c.iterator() ; i.hasNext() ; ){
NameList nl = i.next();
nl.deleteItem();
}
}

Iterating using an enhanced for loop in collections:

public void deleteAll(Collection<NameList> c){
for ( NameList nl : c ){
nl.deleteItem();
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 39 of 40

Sun Educational Services

The Enhanced for Loop

Nested enhanced for loops:
1
2
3
4
5
6
7
8

List<Subject> subjects=...;
List<Teacher> teachers=...;
List<Course> courseList = ArrayList<Course)();
for (Subject subj: subjects) {
for (Teacher tchr: teachers) {
courseList.add(new Course(subj, tchr));
}
}

Java Programming Language

Copyright Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Sun Services, Revision G.2

Module 9, slide 40 of 40