1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5
<!-- Generated by javadoc (build 1.5.0_16) on Sat Jan 23 11:55:17 GMT 2010 -->
10
<META NAME="keywords" CONTENT="org.simpleframework.xml.stream.NodeMap interface">
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
<SCRIPT type="text/javascript">
15
function windowTitle()
17
parent.document.title="NodeMap";
25
<BODY BGCOLOR="white" onload="windowTitle();">
28
<!-- ========= START OF TOP NAVBAR ======= -->
29
<A NAME="navbar_top"><!-- --></A>
30
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34
<A NAME="navbar_top_firstrow"><!-- --></A>
35
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36
<TR ALIGN="center" VALIGN="top">
37
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
38
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
39
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
40
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
41
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
42
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
43
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54
<A HREF="../../../../org/simpleframework/xml/stream/NodeException.html" title="class in org.simpleframework.xml.stream"><B>PREV CLASS</B></A>
55
<A HREF="../../../../org/simpleframework/xml/stream/OutputNode.html" title="interface in org.simpleframework.xml.stream"><B>NEXT CLASS</B></A></FONT></TD>
56
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57
<A HREF="../../../../index.html?org/simpleframework/xml/stream/NodeMap.html" target="_top"><B>FRAMES</B></A>
58
<A HREF="NodeMap.html" target="_top"><B>NO FRAMES</B></A>
59
<SCRIPT type="text/javascript">
62
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
74
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
76
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
80
<A NAME="skip-navbar_top"></A>
81
<!-- ========= END OF TOP NAVBAR ========= -->
84
<!-- ======== START OF CLASS DATA ======== -->
87
org.simpleframework.xml.stream</FONT>
89
Interface NodeMap<T extends <A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream">Node</A>></H2>
91
<DT><B>All Superinterfaces:</B> <DD>java.lang.Iterable<java.lang.String></DD>
95
<DT><PRE>public interface <B>NodeMap<T extends <A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream">Node</A>></B><DT>extends java.lang.Iterable<java.lang.String></DL>
99
The <code>NodeMap</code> object represents a map of nodes that
100
can be set as name value pairs. This typically represents the
101
attributes that belong to an element and is used as an neutral
102
way to access an element for either an input or output event.
107
<DT><B>Author:</B></DT>
108
<DD>Niall Gallagher</DD>
109
<DT><B>See Also:</B><DD><A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream"><CODE>Node</CODE></A></DL>
114
<!-- ========== METHOD SUMMARY =========== -->
116
<A NAME="method_summary"><!-- --></A>
117
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120
<B>Method Summary</B></FONT></TH>
122
<TR BGCOLOR="white" CLASS="TableRowColor">
123
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A></CODE></FONT></TD>
125
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html#get(java.lang.String)">get</A></B>(java.lang.String name)</CODE>
128
This is used to acquire the <code>Node</code> mapped to the
131
<TR BGCOLOR="white" CLASS="TableRowColor">
132
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133
<CODE> java.lang.String</CODE></FONT></TD>
134
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html#getName()">getName</A></B>()</CODE>
137
This is used to get the name of the element that owns the
138
nodes for the specified map.</TD>
140
<TR BGCOLOR="white" CLASS="TableRowColor">
141
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A></CODE></FONT></TD>
143
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html#getNode()">getNode</A></B>()</CODE>
146
This is used to acquire the actual node this map represents.</TD>
148
<TR BGCOLOR="white" CLASS="TableRowColor">
149
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150
<CODE> java.util.Iterator<java.lang.String></CODE></FONT></TD>
151
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html#iterator()">iterator</A></B>()</CODE>
154
This returns an iterator for the names of all the nodes in
155
this <code>NodeMap</code>.</TD>
157
<TR BGCOLOR="white" CLASS="TableRowColor">
158
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A></CODE></FONT></TD>
160
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html#put(java.lang.String, java.lang.String)">put</A></B>(java.lang.String name,
161
java.lang.String value)</CODE>
164
This is used to add a new <code>Node</code> to the map.</TD>
166
<TR BGCOLOR="white" CLASS="TableRowColor">
167
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A></CODE></FONT></TD>
169
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html#remove(java.lang.String)">remove</A></B>(java.lang.String name)</CODE>
172
This is used to remove the <code>Node</code> mapped to the
179
<!-- ============ METHOD DETAIL ========== -->
181
<A NAME="method_detail"><!-- --></A>
182
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
184
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
185
<B>Method Detail</B></FONT></TH>
189
<A NAME="getNode()"><!-- --></A><H3>
192
<A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A> <B>getNode</B>()</PRE>
194
<DD>This is used to acquire the actual node this map represents.
195
The source node provides further details on the context of
196
the node, such as the parent name, the namespace, and even
197
the value in the node. Care should be taken when using this.
204
<DT><B>Returns:</B><DD>this returns the node that this map represents</DL>
209
<A NAME="getName()"><!-- --></A><H3>
212
java.lang.String <B>getName</B>()</PRE>
214
<DD>This is used to get the name of the element that owns the
215
nodes for the specified map. This can be used to determine
216
which element the node map belongs to.
223
<DT><B>Returns:</B><DD>this returns the name of the owning element</DL>
228
<A NAME="get(java.lang.String)"><!-- --></A><H3>
231
<A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A> <B>get</B>(java.lang.String name)</PRE>
233
<DD>This is used to acquire the <code>Node</code> mapped to the
234
given name. This returns a name value pair that represents
235
either an attribute or element. If no node is mapped to the
236
specified name then this method will return null.
242
<DT><B>Parameters:</B><DD><CODE>name</CODE> - this is the name of the node to retrieve
243
<DT><B>Returns:</B><DD>this will return the node mapped to the given name</DL>
248
<A NAME="remove(java.lang.String)"><!-- --></A><H3>
251
<A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A> <B>remove</B>(java.lang.String name)</PRE>
253
<DD>This is used to remove the <code>Node</code> mapped to the
254
given name. This returns a name value pair that represents
255
either an attribute or element. If no node is mapped to the
256
specified name then this method will return null.
262
<DT><B>Parameters:</B><DD><CODE>name</CODE> - this is the name of the node to remove
263
<DT><B>Returns:</B><DD>this will return the node mapped to the given name</DL>
268
<A NAME="iterator()"><!-- --></A><H3>
271
java.util.Iterator<java.lang.String> <B>iterator</B>()</PRE>
273
<DD>This returns an iterator for the names of all the nodes in
274
this <code>NodeMap</code>. This allows the names to be
275
iterated within a for each loop in order to extract nodes.
278
<DT><B>Specified by:</B><DD><CODE>iterator</CODE> in interface <CODE>java.lang.Iterable<java.lang.String></CODE></DL>
282
<DT><B>Returns:</B><DD>this returns the names of the nodes in the map</DL>
287
<A NAME="put(java.lang.String, java.lang.String)"><!-- --></A><H3>
290
<A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="type parameter in NodeMap">T</A> <B>put</B>(java.lang.String name,
291
java.lang.String value)</PRE>
293
<DD>This is used to add a new <code>Node</code> to the map. The
294
type of node that is created an added is left up to the map
295
implementation. Once a node is created with the name value
296
pair it can be retrieved and used.
302
<DT><B>Parameters:</B><DD><CODE>name</CODE> - this is the name of the node to be created<DD><CODE>value</CODE> - this is the value to be given to the node
303
<DT><B>Returns:</B><DD>this is the node that has been added to the map</DL>
306
<!-- ========= END OF CLASS DATA ========= -->
310
<!-- ======= START OF BOTTOM NAVBAR ====== -->
311
<A NAME="navbar_bottom"><!-- --></A>
312
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
313
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
315
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
316
<A NAME="navbar_bottom_firstrow"><!-- --></A>
317
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
318
<TR ALIGN="center" VALIGN="top">
319
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
320
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
321
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
322
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
323
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
324
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
325
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
329
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
335
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
336
<A HREF="../../../../org/simpleframework/xml/stream/NodeException.html" title="class in org.simpleframework.xml.stream"><B>PREV CLASS</B></A>
337
<A HREF="../../../../org/simpleframework/xml/stream/OutputNode.html" title="interface in org.simpleframework.xml.stream"><B>NEXT CLASS</B></A></FONT></TD>
338
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
339
<A HREF="../../../../index.html?org/simpleframework/xml/stream/NodeMap.html" target="_top"><B>FRAMES</B></A>
340
<A HREF="NodeMap.html" target="_top"><B>NO FRAMES</B></A>
341
<SCRIPT type="text/javascript">
344
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
349
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
356
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
357
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
358
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
359
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
362
<A NAME="skip-navbar_bottom"></A>
363
<!-- ======== END OF BOTTOM NAVBAR ======= -->