|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractSet<T>
org.simpleframework.xml.util.Dictionary<T>
public class Dictionary<T extends Entry>
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.
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(java.lang.String name)
This is used to acquire an Entry from the set by
its name. |
java.util.Iterator<T> |
iterator()
Returns an iterator of Entry objects which can be
used to remove items from this set. |
T |
remove(java.lang.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 |
---|
protected final org.simpleframework.xml.util.Dictionary.Table<T extends Entry> map
Constructor Detail |
---|
public Dictionary()
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 |
---|
public boolean add(T item)
Entry
object.
add
in interface java.util.Collection<T extends Entry>
add
in interface java.util.Set<T extends Entry>
add
in class java.util.AbstractCollection<T extends Entry>
item
- this is the entry object that is to be insertedpublic int size()
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.
size
in interface java.util.Collection<T extends Entry>
size
in interface java.util.Set<T extends Entry>
size
in class java.util.AbstractCollection<T extends Entry>
public java.util.Iterator<T> iterator()
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.
iterator
in interface java.lang.Iterable<T extends Entry>
iterator
in interface java.util.Collection<T extends Entry>
iterator
in interface java.util.Set<T extends Entry>
iterator
in class java.util.AbstractCollection<T extends Entry>
public T get(java.lang.String name)
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.
name
- this is the name of the entry object to retrieve
public T remove(java.lang.String name)
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.
name
- this is the name of the entry object to remove
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |