Package org.simpleframework.xml.stream
Interface NodeMap<T extends Node>
- All Known Implementing Classes:
InputNodeMap
,OutputNodeMap
The
NodeMap
object represents a map of nodes that
can be set as name value pairs. This typically represents the
attributes that belong to an element and is used as an neutral
way to access an element for either an input or output event.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionThis is used to acquire theNode
mapped to the given name.getName()
This is used to get the name of the element that owns the nodes for the specified map.getNode()
This is used to acquire the actual node this map represents.iterator()
This returns an iterator for the names of all the nodes in thisNodeMap
.This is used to add a newNode
to the map.This is used to remove theNode
mapped to the given name.Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
getNode
T getNode()This is used to acquire the actual node this map represents. The source node provides further details on the context of the node, such as the parent name, the namespace, and even the value in the node. Care should be taken when using this.- Returns:
- this returns the node that this map represents
-
getName
String getName()This is used to get the name of the element that owns the nodes for the specified map. This can be used to determine which element the node map belongs to.- Returns:
- this returns the name of the owning element
-
get
This is used to acquire theNode
mapped to the given name. This returns a name value pair that represents either an attribute or element. If no node is mapped to the specified name then this method will return null.- Parameters:
name
- this is the name of the node to retrieve- Returns:
- this will return the node mapped to the given name
-
remove
This is used to remove theNode
mapped to the given name. This returns a name value pair that represents either an attribute or element. If no node is mapped to the specified name then this method will return null.- Parameters:
name
- this is the name of the node to remove- Returns:
- this will return the node mapped to the given name
-
iterator
This returns an iterator for the names of all the nodes in thisNodeMap
. This allows the names to be iterated within a for each loop in order to extract nodes. -
put
This is used to add a newNode
to the map. The type of node that is created an added is left up to the map implementation. Once a node is created with the name value pair it can be retrieved and used.- Parameters:
name
- this is the name of the node to be createdvalue
- this is the value to be given to the node- Returns:
- this is the node that has been added to the map
-