Package org.simpleframework.xml.core

Class ContactMap

java.lang.Object

java.util.AbstractMap<Object,Contact>

java.util.HashMap<Object,Contact>

java.util.LinkedHashMap<Object,Contact>

org.simpleframework.xml.core.ContactMap

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Contact>, Map<Object,Contact>, SequencedMap<Object,Contact>

class ContactMap
extends LinkedHashMap<Object,Contact>
implements Iterable<Contact>

The ContactMap object is used to keep track of the contacts that have been processed. Keeping track of the contacts that have been processed ensures that no two contacts are used twice. This ensures a consistent XML class schema.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
ContactMap()

Method Summary

Modifier and Type	Method	Description
Iterator<Contact>	iterator()	This is used to iterate over the Contact objects in a for each loop.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Constructor Details

ContactMap

ContactMap()

Method Details

iterator

public Iterator<Contact> iterator()

This is used to iterate over the Contact objects in a for each loop. Iterating over the contacts allows them to be easily added to a list of unique contacts.

Specified by:

iterator in interface Iterable<Contact>

Returns:

this is used to return the contacts registered