/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html

http://prototipomemoria.googlecode.com/ · HTML · 446 lines · 381 code · 43 blank · 22 comment · 0 complexity · f4fa3fce6c7b409a149ca83e17c2d90d MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:24 CEST 2011 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <TITLE>
  8. XmlFriendlyNameCoder (XStream Core 1.4.1 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2011-08-11">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="XmlFriendlyNameCoder (XStream Core 1.4.1 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlFriendlyNameCoder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/WstxDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReader.html" title="interface in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="XmlFriendlyNameCoder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. com.thoughtworks.xstream.io.xml</FONT>
  82. <BR>
  83. Class XmlFriendlyNameCoder</H2>
  84. <PRE>
  85. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  86. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.xml.XmlFriendlyNameCoder</B>
  87. </PRE>
  88. <DL>
  89. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD>
  90. </DL>
  91. <DL>
  92. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XStream11NameCoder.html" title="class in com.thoughtworks.xstream.io.xml">XStream11NameCoder</A></DD>
  93. </DL>
  94. <HR>
  95. <DL>
  96. <DT><PRE>public class <B>XmlFriendlyNameCoder</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL>
  97. </PRE>
  98. <P>
  99. Encode and decode tag and attribute names in XML drivers.
  100. <p>
  101. This NameCoder is designed to ensure the correct encoding and decoding of names used for Java
  102. types and fields to XML tags and attribute names.
  103. </p>
  104. <p>
  105. The default replacements are:
  106. </p>
  107. <ul>
  108. <li><b>$</b> (dollar) chars are replaced with <b>_-</b> (underscore dash) string.</li>
  109. <li><b>_</b> (underscore) chars are replaced with <b>__</b> (double underscore) string.</li>
  110. <li>other characters that are invalid in XML names are encoded with <b>_.XXXX</b> (underscore
  111. dot followed by hex representation of character).</li>
  112. </ul>
  113. <P>
  114. <P>
  115. <DL>
  116. <DT><B>Since:</B></DT>
  117. <DD>1.4</DD>
  118. <DT><B>Author:</B></DT>
  119. <DD>J&ouml;rg Schaible, Mauro Talevi, Tatu Saloranta, Michael Schnell</DD>
  120. <DT><B>See Also:</B><DD><a href="http://www.w3.org/TR/REC-xml/#dt-name">XML 1.0 name definition</a>,
  121. <a href="http://www.w3.org/TR/xml11/#dt-name">XML 1.1 name definition</a>,
  122. <a href="http://java.sun.com/docs/books/jls/third_edition/html/lexical.html#3.8">Java
  123. identifier definition</a></DL>
  124. <HR>
  125. <P>
  126. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  127. <A NAME="constructor_summary"><!-- --></A>
  128. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  129. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  130. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  131. <B>Constructor Summary</B></FONT></TH>
  132. </TR>
  133. <TR BGCOLOR="white" CLASS="TableRowColor">
  134. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#XmlFriendlyNameCoder()">XmlFriendlyNameCoder</A></B>()</CODE>
  135. <BR>
  136. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new XmlFriendlyNameCoder.</TD>
  137. </TR>
  138. <TR BGCOLOR="white" CLASS="TableRowColor">
  139. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#XmlFriendlyNameCoder(java.lang.String, java.lang.String)">XmlFriendlyNameCoder</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;dollarReplacement,
  140. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;escapeCharReplacement)</CODE>
  141. <BR>
  142. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new XmlFriendlyNameCoder with custom replacement strings for dollar and the
  143. escape character.</TD>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#XmlFriendlyNameCoder(java.lang.String, java.lang.String, java.lang.String)">XmlFriendlyNameCoder</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;dollarReplacement,
  147. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;escapeCharReplacement,
  148. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;hexPrefix)</CODE>
  149. <BR>
  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new XmlFriendlyNameCoder with custom replacement strings for dollar, the
  151. escape character and the prefix for hexadecimal encoding of invalid characters in XML
  152. names.</TD>
  153. </TR>
  154. </TABLE>
  155. &nbsp;
  156. <!-- ========== METHOD SUMMARY =========== -->
  157. <A NAME="method_summary"><!-- --></A>
  158. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  159. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  160. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  161. <B>Method Summary</B></FONT></TH>
  162. </TR>
  163. <TR BGCOLOR="white" CLASS="TableRowColor">
  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  165. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
  166. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#clone()">clone</A></B>()</CODE>
  167. <BR>
  168. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  169. </TR>
  170. <TR BGCOLOR="white" CLASS="TableRowColor">
  171. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  172. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  173. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#decodeAttribute(java.lang.String)">decodeAttribute</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attributeName)</CODE>
  174. <BR>
  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode an attribute name to an object name.</TD>
  176. </TR>
  177. <TR BGCOLOR="white" CLASS="TableRowColor">
  178. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  179. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  180. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#decodeNode(java.lang.String)">decodeNode</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;elementName)</CODE>
  181. <BR>
  182. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode a node name to an object name.</TD>
  183. </TR>
  184. <TR BGCOLOR="white" CLASS="TableRowColor">
  185. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  186. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  187. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#encodeAttribute(java.lang.String)">encodeAttribute</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
  188. <BR>
  189. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encode a meta-data name for an attribute in the target format.</TD>
  190. </TR>
  191. <TR BGCOLOR="white" CLASS="TableRowColor">
  192. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  193. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
  194. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html#encodeNode(java.lang.String)">encodeNode</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
  195. <BR>
  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encode an object name for a node in the target format.</TD>
  197. </TR>
  198. </TABLE>
  199. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  200. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  201. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  202. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
  203. </TR>
  204. <TR BGCOLOR="white" CLASS="TableRowColor">
  205. <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  206. </TR>
  207. </TABLE>
  208. &nbsp;
  209. <P>
  210. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  211. <A NAME="constructor_detail"><!-- --></A>
  212. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  213. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  214. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  215. <B>Constructor Detail</B></FONT></TH>
  216. </TR>
  217. </TABLE>
  218. <A NAME="XmlFriendlyNameCoder()"><!-- --></A><H3>
  219. XmlFriendlyNameCoder</H3>
  220. <PRE>
  221. public <B>XmlFriendlyNameCoder</B>()</PRE>
  222. <DL>
  223. <DD>Construct a new XmlFriendlyNameCoder.
  224. <P>
  225. <DL>
  226. <DT><B>Since:</B></DT>
  227. <DD>1.4</DD>
  228. </DL>
  229. </DL>
  230. <HR>
  231. <A NAME="XmlFriendlyNameCoder(java.lang.String, java.lang.String)"><!-- --></A><H3>
  232. XmlFriendlyNameCoder</H3>
  233. <PRE>
  234. public <B>XmlFriendlyNameCoder</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;dollarReplacement,
  235. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;escapeCharReplacement)</PRE>
  236. <DL>
  237. <DD>Construct a new XmlFriendlyNameCoder with custom replacement strings for dollar and the
  238. escape character.
  239. <P>
  240. <DL>
  241. <DT><B>Parameters:</B><DD><CODE>dollarReplacement</CODE> - <DD><CODE>escapeCharReplacement</CODE> - <DT><B>Since:</B></DT>
  242. <DD>1.4</DD>
  243. </DL>
  244. </DL>
  245. <HR>
  246. <A NAME="XmlFriendlyNameCoder(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
  247. XmlFriendlyNameCoder</H3>
  248. <PRE>
  249. public <B>XmlFriendlyNameCoder</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;dollarReplacement,
  250. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;escapeCharReplacement,
  251. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;hexPrefix)</PRE>
  252. <DL>
  253. <DD>Construct a new XmlFriendlyNameCoder with custom replacement strings for dollar, the
  254. escape character and the prefix for hexadecimal encoding of invalid characters in XML
  255. names.
  256. <P>
  257. <DL>
  258. <DT><B>Parameters:</B><DD><CODE>dollarReplacement</CODE> - <DD><CODE>escapeCharReplacement</CODE> - <DT><B>Since:</B></DT>
  259. <DD>1.4</DD>
  260. </DL>
  261. </DL>
  262. <!-- ============ METHOD DETAIL ========== -->
  263. <A NAME="method_detail"><!-- --></A>
  264. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  265. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  266. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  267. <B>Method Detail</B></FONT></TH>
  268. </TR>
  269. </TABLE>
  270. <A NAME="decodeAttribute(java.lang.String)"><!-- --></A><H3>
  271. decodeAttribute</H3>
  272. <PRE>
  273. public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>decodeAttribute</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attributeName)</PRE>
  274. <DL>
  275. <DD>Decode an attribute name to an object name.
  276. <P>
  277. <DD><DL>
  278. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html#decodeAttribute(java.lang.String)">decodeAttribute</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A></CODE></DL>
  279. </DD>
  280. <DD><DL>
  281. <DT><B>Parameters:</B><DD><CODE>attributeName</CODE> - the name of the attribute
  282. <DT><B>Returns:</B><DD>the name of the meta-data</DL>
  283. </DD>
  284. </DL>
  285. <HR>
  286. <A NAME="decodeNode(java.lang.String)"><!-- --></A><H3>
  287. decodeNode</H3>
  288. <PRE>
  289. public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>decodeNode</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;elementName)</PRE>
  290. <DL>
  291. <DD>Decode a node name to an object name.
  292. <P>
  293. <DD><DL>
  294. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html#decodeNode(java.lang.String)">decodeNode</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A></CODE></DL>
  295. </DD>
  296. <DD><DL>
  297. <DT><B>Parameters:</B><DD><CODE>elementName</CODE> - the name of the node
  298. <DT><B>Returns:</B><DD>the name of the object</DL>
  299. </DD>
  300. </DL>
  301. <HR>
  302. <A NAME="encodeAttribute(java.lang.String)"><!-- --></A><H3>
  303. encodeAttribute</H3>
  304. <PRE>
  305. public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>encodeAttribute</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
  306. <DL>
  307. <DD>Encode a meta-data name for an attribute in the target format.
  308. <P>
  309. <DD><DL>
  310. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html#encodeAttribute(java.lang.String)">encodeAttribute</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A></CODE></DL>
  311. </DD>
  312. <DD><DL>
  313. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the meta-data
  314. <DT><B>Returns:</B><DD>the attribute name in the target format</DL>
  315. </DD>
  316. </DL>
  317. <HR>
  318. <A NAME="encodeNode(java.lang.String)"><!-- --></A><H3>
  319. encodeNode</H3>
  320. <PRE>
  321. public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>encodeNode</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
  322. <DL>
  323. <DD>Encode an object name for a node in the target format.
  324. <P>
  325. <DD><DL>
  326. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html#encodeNode(java.lang.String)">encodeNode</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A></CODE></DL>
  327. </DD>
  328. <DD><DL>
  329. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the object data
  330. <DT><B>Returns:</B><DD>the node name in the target format</DL>
  331. </DD>
  332. </DL>
  333. <HR>
  334. <A NAME="clone()"><!-- --></A><H3>
  335. clone</H3>
  336. <PRE>
  337. public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>clone</B>()</PRE>
  338. <DL>
  339. <DD><DL>
  340. <DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
  341. </DD>
  342. <DD><DL>
  343. </DL>
  344. </DD>
  345. </DL>
  346. <!-- ========= END OF CLASS DATA ========= -->
  347. <HR>
  348. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  349. <A NAME="navbar_bottom"><!-- --></A>
  350. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  351. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  352. <TR>
  353. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  354. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  355. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  356. <TR ALIGN="center" VALIGN="top">
  357. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  358. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  359. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  360. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlFriendlyNameCoder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  361. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  362. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  363. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  364. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  365. </TR>
  366. </TABLE>
  367. </TD>
  368. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  369. </EM>
  370. </TD>
  371. </TR>
  372. <TR>
  373. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  374. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/WstxDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A>&nbsp;
  375. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReader.html" title="interface in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD>
  376. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  377. <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/XmlFriendlyNameCoder.html" target="_top"><B>FRAMES</B></A> &nbsp;
  378. &nbsp;<A HREF="XmlFriendlyNameCoder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  379. &nbsp;<SCRIPT type="text/javascript">
  380. <!--
  381. if(window==top) {
  382. document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  383. }
  384. //-->
  385. </SCRIPT>
  386. <NOSCRIPT>
  387. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  388. </NOSCRIPT>
  389. </FONT></TD>
  390. </TR>
  391. <TR>
  392. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  393. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  394. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  395. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  396. </TR>
  397. </TABLE>
  398. <A NAME="skip-navbar_bottom"></A>
  399. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  400. <HR>
  401. Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
  402. </BODY>
  403. </HTML>