org.simpleframework.xml.util
Class Dictionary<T extends Entry>

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractSet<T>
          extended by org.simpleframework.xml.util.Dictionary<T>
All Implemented Interfaces:
Iterable<T>, Collection<T>, Set<T>

public class Dictionary<T extends Entry>
extends AbstractSet<T>

The Dictionary object represents a mapped set of entry objects that can be serialized and deserialized. This is used when there is a need to load a list of objects that can be mapped using a name attribute. Using this object avoids the need to implement a commonly required pattern of building a map of XML element objects.


    <dictionary>
       <entry name="example">
          <element>example text</element>
       </entry>
       <entry name="example">
          <element>example text</element>
       </entry>       
    </dictionary>
 
 
This can contain implementations of the Entry object which contains a required "name" attribute. Implementations of the entry object can add further XML attributes an elements. This must be annotated with the ElementList annotation in order to be serialized and deserialized as an object field.

Author:
Niall Gallagher
See Also:
Entry

Field Summary
protected  org.simpleframework.xml.util.Dictionary.Table<T> map
          Used to map the entries to their configured names.
 
Constructor Summary
Dictionary()
          Constructor for the Dictionary object.
 
Method Summary
 boolean add(T item)
          This method is used to add the provided entry to this set.
 T get(String name)
          This is used to acquire an Entry from the set by its name.
 Iterator<T> iterator()
          Returns an iterator of Entry objects which can be used to remove items from this set.
 T remove(String name)
          This is used to remove an Entry from the set by its name.
 int size()
          This returns the number of Entry objects within the dictionary.
 
Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll
 
Methods inherited from class java.util.AbstractCollection
addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray
 

Field Detail

map

protected final org.simpleframework.xml.util.Dictionary.Table<T extends Entry> map
Used to map the entries to their configured names.

Constructor Detail

Dictionary

public Dictionary()
Constructor for the Dictionary object. This is used to create a set that contains entry objects mapped to an XML attribute name value. Entry objects added to this dictionary can be retrieved using its name value.

Method Detail

add

public boolean add(T item)
This method is used to add the provided entry to this set. If an entry of the same name already existed within the set then it is replaced with the specified Entry object.

Specified by:
add in interface Collection<T extends Entry>
Specified by:
add in interface Set<T extends Entry>
Overrides:
add in class AbstractCollection<T extends Entry>
Parameters:
item - this is the entry object that is to be inserted

size

public int size()
This returns the number of Entry objects within the dictionary. This will use the internal map to acquire the number of entry objects that have been inserted to the map.

Specified by:
size in interface Collection<T extends Entry>
Specified by:
size in interface Set<T extends Entry>
Specified by:
size in class AbstractCollection<T extends Entry>
Returns:
this returns the number of entry objects in the set

iterator

public Iterator<T> iterator()
Returns an iterator of Entry objects which can be used to remove items from this set. This will use the internal map object and return the iterator for the map values.

Specified by:
iterator in interface Iterable<T extends Entry>
Specified by:
iterator in interface Collection<T extends Entry>
Specified by:
iterator in interface Set<T extends Entry>
Specified by:
iterator in class AbstractCollection<T extends Entry>
Returns:
this returns an iterator for the entry objects

get

public T get(String name)
This is used to acquire an Entry from the set by its name. This uses the internal map to look for the entry, if the entry exists it is returned, if not this returns null.

Parameters:
name - this is the name of the entry object to retrieve
Returns:
this returns the entry mapped to the specified name

remove

public T remove(String name)
This is used to remove an Entry from the set by its name. This uses the internal map to look for the entry, if the entry exists it is returned and removed from the map.

Parameters:
name - this is the name of the entry object to remove
Returns:
this returns the entry mapped to the specified name